]> CyberLeo.Net >> Repos - FreeBSD/releng/10.2.git/blob - sys/dev/mps/mps_sas_lsi.c
- Copy stable/10@285827 to releng/10.2 in preparation for 10.2-RC1
[FreeBSD/releng/10.2.git] / sys / dev / mps / mps_sas_lsi.c
1 /*-
2  * Copyright (c) 2011-2015 LSI Corp.
3  * Copyright (c) 2013-2015 Avago Technologies
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25  * SUCH DAMAGE.
26  *
27  * Avago Technologies (LSI) MPT-Fusion Host Adapter FreeBSD
28  */
29
30 #include <sys/cdefs.h>
31 __FBSDID("$FreeBSD$");
32
33 /* Communications core for Avago Technologies (LSI) MPT2 */
34
35 /* TODO Move headers to mpsvar */
36 #include <sys/types.h>
37 #include <sys/param.h>
38 #include <sys/systm.h>
39 #include <sys/kernel.h>
40 #include <sys/selinfo.h>
41 #include <sys/module.h>
42 #include <sys/bus.h>
43 #include <sys/conf.h>
44 #include <sys/bio.h>
45 #include <sys/malloc.h>
46 #include <sys/uio.h>
47 #include <sys/sysctl.h>
48 #include <sys/endian.h>
49 #include <sys/queue.h>
50 #include <sys/kthread.h>
51 #include <sys/taskqueue.h>
52 #include <sys/sbuf.h>
53
54 #include <machine/bus.h>
55 #include <machine/resource.h>
56 #include <sys/rman.h>
57
58 #include <machine/stdarg.h>
59
60 #include <cam/cam.h>
61 #include <cam/cam_ccb.h>
62 #include <cam/cam_debug.h>
63 #include <cam/cam_sim.h>
64 #include <cam/cam_xpt_sim.h>
65 #include <cam/cam_xpt_periph.h>
66 #include <cam/cam_periph.h>
67 #include <cam/scsi/scsi_all.h>
68 #include <cam/scsi/scsi_message.h>
69
70 #include <dev/mps/mpi/mpi2_type.h>
71 #include <dev/mps/mpi/mpi2.h>
72 #include <dev/mps/mpi/mpi2_ioc.h>
73 #include <dev/mps/mpi/mpi2_sas.h>
74 #include <dev/mps/mpi/mpi2_cnfg.h>
75 #include <dev/mps/mpi/mpi2_init.h>
76 #include <dev/mps/mpi/mpi2_raid.h>
77 #include <dev/mps/mpi/mpi2_tool.h>
78 #include <dev/mps/mps_ioctl.h>
79 #include <dev/mps/mpsvar.h>
80 #include <dev/mps/mps_table.h>
81 #include <dev/mps/mps_sas.h>
82
83 /* For Hashed SAS Address creation for SATA Drives */
84 #define MPT2SAS_SN_LEN 20
85 #define MPT2SAS_MN_LEN 40
86
87 struct mps_fw_event_work {
88         u16                     event;
89         void                    *event_data;
90         TAILQ_ENTRY(mps_fw_event_work)  ev_link;
91 };
92
93 union _sata_sas_address {
94         u8 wwid[8];
95         struct {
96                 u32 high;
97                 u32 low;
98         } word;
99 };
100
101 /*
102  * define the IDENTIFY DEVICE structure
103  */
104 struct _ata_identify_device_data {
105         u16 reserved1[10];      /* 0-9 */
106         u16 serial_number[10];  /* 10-19 */
107         u16 reserved2[7];       /* 20-26 */
108         u16 model_number[20];   /* 27-46*/
109         u16 reserved3[170];     /* 47-216 */
110         u16 rotational_speed;   /* 217 */
111         u16 reserved4[38];      /* 218-255 */
112 };
113 static u32 event_count;
114 static void mpssas_fw_work(struct mps_softc *sc,
115     struct mps_fw_event_work *fw_event);
116 static void mpssas_fw_event_free(struct mps_softc *,
117     struct mps_fw_event_work *);
118 static int mpssas_add_device(struct mps_softc *sc, u16 handle, u8 linkrate);
119 static int mpssas_get_sata_identify(struct mps_softc *sc, u16 handle,
120     Mpi2SataPassthroughReply_t *mpi_reply, char *id_buffer, int sz,
121     u32 devinfo);
122 static void mpssas_ata_id_timeout(void *data);
123 int mpssas_get_sas_address_for_sata_disk(struct mps_softc *sc,
124     u64 *sas_address, u16 handle, u32 device_info, u8 *is_SATA_SSD);
125 static int mpssas_volume_add(struct mps_softc *sc,
126     u16 handle);
127 static void mpssas_SSU_to_SATA_devices(struct mps_softc *sc);
128 static void mpssas_stop_unit_done(struct cam_periph *periph,
129     union ccb *done_ccb);
130
131 void
132 mpssas_evt_handler(struct mps_softc *sc, uintptr_t data,
133     MPI2_EVENT_NOTIFICATION_REPLY *event)
134 {
135         struct mps_fw_event_work *fw_event;
136         u16 sz;
137
138         mps_dprint(sc, MPS_TRACE, "%s\n", __func__);
139         mps_print_evt_sas(sc, event);
140         mpssas_record_event(sc, event);
141
142         fw_event = malloc(sizeof(struct mps_fw_event_work), M_MPT2,
143              M_ZERO|M_NOWAIT);
144         if (!fw_event) {
145                 printf("%s: allocate failed for fw_event\n", __func__);
146                 return;
147         }
148         sz = le16toh(event->EventDataLength) * 4;
149         fw_event->event_data = malloc(sz, M_MPT2, M_ZERO|M_NOWAIT);
150         if (!fw_event->event_data) {
151                 printf("%s: allocate failed for event_data\n", __func__);
152                 free(fw_event, M_MPT2);
153                 return;
154         }
155
156         bcopy(event->EventData, fw_event->event_data, sz);
157         fw_event->event = event->Event;
158         if ((event->Event == MPI2_EVENT_SAS_TOPOLOGY_CHANGE_LIST ||
159             event->Event == MPI2_EVENT_SAS_ENCL_DEVICE_STATUS_CHANGE ||
160             event->Event == MPI2_EVENT_IR_CONFIGURATION_CHANGE_LIST) &&
161             sc->track_mapping_events)
162                 sc->pending_map_events++;
163
164         /*
165          * When wait_for_port_enable flag is set, make sure that all the events
166          * are processed. Increment the startup_refcount and decrement it after
167          * events are processed.
168          */
169         if ((event->Event == MPI2_EVENT_SAS_TOPOLOGY_CHANGE_LIST ||
170             event->Event == MPI2_EVENT_IR_CONFIGURATION_CHANGE_LIST) &&
171             sc->wait_for_port_enable)
172                 mpssas_startup_increment(sc->sassc);
173
174         TAILQ_INSERT_TAIL(&sc->sassc->ev_queue, fw_event, ev_link);
175         taskqueue_enqueue(sc->sassc->ev_tq, &sc->sassc->ev_task);
176
177 }
178
179 static void
180 mpssas_fw_event_free(struct mps_softc *sc, struct mps_fw_event_work *fw_event)
181 {
182
183         free(fw_event->event_data, M_MPT2);
184         free(fw_event, M_MPT2);
185 }
186
187 /**
188  * _mps_fw_work - delayed task for processing firmware events
189  * @sc: per adapter object
190  * @fw_event: The fw_event_work object
191  * Context: user.
192  *
193  * Return nothing.
194  */
195 static void
196 mpssas_fw_work(struct mps_softc *sc, struct mps_fw_event_work *fw_event)
197 {
198         struct mpssas_softc *sassc;
199         sassc = sc->sassc;
200
201         mps_dprint(sc, MPS_EVENT, "(%d)->(%s) Working on  Event: [%x]\n",
202                         event_count++,__func__,fw_event->event);
203         switch (fw_event->event) {
204         case MPI2_EVENT_SAS_TOPOLOGY_CHANGE_LIST: 
205         {
206                 MPI2_EVENT_DATA_SAS_TOPOLOGY_CHANGE_LIST *data;
207                 MPI2_EVENT_SAS_TOPO_PHY_ENTRY *phy;
208                 int i;
209
210                 data = (MPI2_EVENT_DATA_SAS_TOPOLOGY_CHANGE_LIST *)
211                     fw_event->event_data;
212
213                 mps_mapping_topology_change_event(sc, fw_event->event_data);
214
215                 for (i = 0; i < data->NumEntries; i++) {
216                         phy = &data->PHY[i];
217                         switch (phy->PhyStatus & MPI2_EVENT_SAS_TOPO_RC_MASK) {
218                         case MPI2_EVENT_SAS_TOPO_RC_TARG_ADDED:
219                                 if (mpssas_add_device(sc,
220                                     le16toh(phy->AttachedDevHandle), phy->LinkRate)){
221                                         printf("%s: failed to add device with "
222                                             "handle 0x%x\n", __func__,
223                                             le16toh(phy->AttachedDevHandle));
224                                         mpssas_prepare_remove(sassc, le16toh(
225                                                 phy->AttachedDevHandle));
226                                 }
227                                 break;
228                         case MPI2_EVENT_SAS_TOPO_RC_TARG_NOT_RESPONDING:
229                                 mpssas_prepare_remove(sassc,le16toh( 
230                                         phy->AttachedDevHandle));
231                                 break;
232                         case MPI2_EVENT_SAS_TOPO_RC_PHY_CHANGED:
233                         case MPI2_EVENT_SAS_TOPO_RC_NO_CHANGE:
234                         case MPI2_EVENT_SAS_TOPO_RC_DELAY_NOT_RESPONDING:
235                         default:
236                                 break;
237                         }
238                 }
239                 /*
240                  * refcount was incremented for this event in
241                  * mpssas_evt_handler.  Decrement it here because the event has
242                  * been processed.
243                  */
244                 mpssas_startup_decrement(sassc);
245                 break;
246         }
247         case MPI2_EVENT_SAS_DISCOVERY:
248         {
249                 MPI2_EVENT_DATA_SAS_DISCOVERY *data;
250
251                 data = (MPI2_EVENT_DATA_SAS_DISCOVERY *)fw_event->event_data;
252
253                 if (data->ReasonCode & MPI2_EVENT_SAS_DISC_RC_STARTED)
254                         mps_dprint(sc, MPS_TRACE,"SAS discovery start event\n");
255                 if (data->ReasonCode & MPI2_EVENT_SAS_DISC_RC_COMPLETED) {
256                         mps_dprint(sc, MPS_TRACE,"SAS discovery stop event\n");
257                         sassc->flags &= ~MPSSAS_IN_DISCOVERY;
258                         mpssas_discovery_end(sassc);
259                 }
260                 break;
261         }
262         case MPI2_EVENT_SAS_ENCL_DEVICE_STATUS_CHANGE:
263         {
264                 Mpi2EventDataSasEnclDevStatusChange_t *data;
265                 data = (Mpi2EventDataSasEnclDevStatusChange_t *)
266                     fw_event->event_data;
267                 mps_mapping_enclosure_dev_status_change_event(sc,
268                     fw_event->event_data);
269                 break;
270         }
271         case MPI2_EVENT_IR_CONFIGURATION_CHANGE_LIST:
272         {
273                 Mpi2EventIrConfigElement_t *element;
274                 int i;
275                 u8 foreign_config;
276                 Mpi2EventDataIrConfigChangeList_t *event_data;
277                 struct mpssas_target *targ;
278                 unsigned int id;
279
280                 event_data = fw_event->event_data;
281                 foreign_config = (le32toh(event_data->Flags) &
282                     MPI2_EVENT_IR_CHANGE_FLAGS_FOREIGN_CONFIG) ? 1 : 0;
283
284                 element =
285                     (Mpi2EventIrConfigElement_t *)&event_data->ConfigElement[0];
286                 id = mps_mapping_get_raid_id_from_handle
287                     (sc, element->VolDevHandle);
288
289                 mps_mapping_ir_config_change_event(sc, event_data);
290
291                 for (i = 0; i < event_data->NumElements; i++, element++) {
292                         switch (element->ReasonCode) {
293                         case MPI2_EVENT_IR_CHANGE_RC_VOLUME_CREATED:
294                         case MPI2_EVENT_IR_CHANGE_RC_ADDED:
295                                 if (!foreign_config) {
296                                         if (mpssas_volume_add(sc, le16toh(element->VolDevHandle))){
297                                                 printf("%s: failed to add RAID "
298                                                     "volume with handle 0x%x\n",
299                                                     __func__, le16toh(element->
300                                                     VolDevHandle));
301                                         }
302                                 }
303                                 break;
304                         case MPI2_EVENT_IR_CHANGE_RC_VOLUME_DELETED:
305                         case MPI2_EVENT_IR_CHANGE_RC_REMOVED:
306                                 /*
307                                  * Rescan after volume is deleted or removed.
308                                  */
309                                 if (!foreign_config) {
310                                         if (id == MPS_MAP_BAD_ID) {
311                                                 printf("%s: could not get ID "
312                                                     "for volume with handle "
313                                                     "0x%04x\n", __func__,
314                                                     le16toh(element->VolDevHandle));
315                                                 break;
316                                         }
317                                         
318                                         targ = &sassc->targets[id];
319                                         targ->handle = 0x0;
320                                         targ->encl_slot = 0x0;
321                                         targ->encl_handle = 0x0;
322                                         targ->exp_dev_handle = 0x0;
323                                         targ->phy_num = 0x0;
324                                         targ->linkrate = 0x0;
325                                         mpssas_rescan_target(sc, targ);
326                                         printf("RAID target id 0x%x removed\n",
327                                             targ->tid);
328                                 }
329                                 break;
330                         case MPI2_EVENT_IR_CHANGE_RC_PD_CREATED:
331                         case MPI2_EVENT_IR_CHANGE_RC_HIDE:
332                                 /*
333                                  * Phys Disk of a volume has been created.  Hide
334                                  * it from the OS.
335                                  */
336                                 targ = mpssas_find_target_by_handle(sassc, 0, element->PhysDiskDevHandle);
337                                 if (targ == NULL) 
338                                         break;
339                                 
340                                 /* Set raid component flags only if it is not WD.
341                                  * OR WrapDrive with WD_HIDE_ALWAYS/WD_HIDE_IF_VOLUME is set in NVRAM
342                                  */
343                                 if((!sc->WD_available) ||
344                                 ((sc->WD_available && 
345                                 (sc->WD_hide_expose == MPS_WD_HIDE_ALWAYS)) ||
346                                 (sc->WD_valid_config && (sc->WD_hide_expose ==
347                                 MPS_WD_HIDE_IF_VOLUME)))) {
348                                         targ->flags |= MPS_TARGET_FLAGS_RAID_COMPONENT;
349                                 }
350                                 mpssas_rescan_target(sc, targ);
351                                 
352                                 break;
353                         case MPI2_EVENT_IR_CHANGE_RC_PD_DELETED:
354                                 /*
355                                  * Phys Disk of a volume has been deleted.
356                                  * Expose it to the OS.
357                                  */
358                                 if (mpssas_add_device(sc,
359                                     le16toh(element->PhysDiskDevHandle), 0)){
360                                         printf("%s: failed to add device with "
361                                             "handle 0x%x\n", __func__,
362                                             le16toh(element->PhysDiskDevHandle));
363                                         mpssas_prepare_remove(sassc, le16toh(element->
364                                             PhysDiskDevHandle));
365                                 }
366                                 break;
367                         }
368                 }
369                 /*
370                  * refcount was incremented for this event in
371                  * mpssas_evt_handler.  Decrement it here because the event has
372                  * been processed.
373                  */
374                 mpssas_startup_decrement(sassc);
375                 break;
376         }
377         case MPI2_EVENT_IR_VOLUME:
378         {
379                 Mpi2EventDataIrVolume_t *event_data = fw_event->event_data;
380
381                 /*
382                  * Informational only.
383                  */
384                 mps_dprint(sc, MPS_EVENT, "Received IR Volume event:\n");
385                 switch (event_data->ReasonCode) {
386                 case MPI2_EVENT_IR_VOLUME_RC_SETTINGS_CHANGED:
387                         mps_dprint(sc, MPS_EVENT, "   Volume Settings "
388                             "changed from 0x%x to 0x%x for Volome with "
389                             "handle 0x%x", le32toh(event_data->PreviousValue),
390                             le32toh(event_data->NewValue),
391                             le16toh(event_data->VolDevHandle));
392                         break;
393                 case MPI2_EVENT_IR_VOLUME_RC_STATUS_FLAGS_CHANGED:
394                         mps_dprint(sc, MPS_EVENT, "   Volume Status "
395                             "changed from 0x%x to 0x%x for Volome with "
396                             "handle 0x%x", le32toh(event_data->PreviousValue),
397                             le32toh(event_data->NewValue),
398                             le16toh(event_data->VolDevHandle));
399                         break;
400                 case MPI2_EVENT_IR_VOLUME_RC_STATE_CHANGED:
401                         mps_dprint(sc, MPS_EVENT, "   Volume State "
402                             "changed from 0x%x to 0x%x for Volome with "
403                             "handle 0x%x", le32toh(event_data->PreviousValue),
404                             le32toh(event_data->NewValue),
405                             le16toh(event_data->VolDevHandle));
406                                 u32 state;
407                                 struct mpssas_target *targ;
408                                 state = le32toh(event_data->NewValue);
409                                 switch (state) {
410                                 case MPI2_RAID_VOL_STATE_MISSING:
411                                 case MPI2_RAID_VOL_STATE_FAILED:
412                                         mpssas_prepare_volume_remove(sassc, event_data->
413                                                         VolDevHandle);
414                                         break;
415                  
416                                 case MPI2_RAID_VOL_STATE_ONLINE:
417                                 case MPI2_RAID_VOL_STATE_DEGRADED:
418                                 case MPI2_RAID_VOL_STATE_OPTIMAL:
419                                         targ = mpssas_find_target_by_handle(sassc, 0, event_data->VolDevHandle);
420                                         if (targ) {
421                                                 printf("%s %d: Volume handle 0x%x is already added \n",
422                                                                 __func__, __LINE__ , event_data->VolDevHandle);
423                                                 break;
424                                         }
425                                         if (mpssas_volume_add(sc, le16toh(event_data->VolDevHandle))) {
426                                                 printf("%s: failed to add RAID "
427                                                         "volume with handle 0x%x\n",
428                                                         __func__, le16toh(event_data->
429                                                         VolDevHandle));
430                                         }
431                                         break;
432                                 default:
433                                         break;
434                                 }
435                         break;
436                 default:
437                         break;
438                 }
439                 break;
440         }
441         case MPI2_EVENT_IR_PHYSICAL_DISK:
442         {
443                 Mpi2EventDataIrPhysicalDisk_t *event_data =
444                     fw_event->event_data;
445                 struct mpssas_target *targ;
446
447                 /*
448                  * Informational only.
449                  */
450                 mps_dprint(sc, MPS_EVENT, "Received IR Phys Disk event:\n");
451                 switch (event_data->ReasonCode) {
452                 case MPI2_EVENT_IR_PHYSDISK_RC_SETTINGS_CHANGED:
453                         mps_dprint(sc, MPS_EVENT, "   Phys Disk Settings "
454                             "changed from 0x%x to 0x%x for Phys Disk Number "
455                             "%d and handle 0x%x at Enclosure handle 0x%x, Slot "
456                             "%d", le32toh(event_data->PreviousValue),
457                             le32toh(event_data->NewValue),
458                                 event_data->PhysDiskNum,
459                             le16toh(event_data->PhysDiskDevHandle),
460                             le16toh(event_data->EnclosureHandle), le16toh(event_data->Slot));
461                         break;
462                 case MPI2_EVENT_IR_PHYSDISK_RC_STATUS_FLAGS_CHANGED:
463                         mps_dprint(sc, MPS_EVENT, "   Phys Disk Status changed "
464                             "from 0x%x to 0x%x for Phys Disk Number %d and "
465                             "handle 0x%x at Enclosure handle 0x%x, Slot %d",
466                                 le32toh(event_data->PreviousValue),
467                             le32toh(event_data->NewValue), event_data->PhysDiskNum,
468                             le16toh(event_data->PhysDiskDevHandle),
469                             le16toh(event_data->EnclosureHandle), le16toh(event_data->Slot));
470                         break;
471                 case MPI2_EVENT_IR_PHYSDISK_RC_STATE_CHANGED:
472                         mps_dprint(sc, MPS_EVENT, "   Phys Disk State changed "
473                             "from 0x%x to 0x%x for Phys Disk Number %d and "
474                             "handle 0x%x at Enclosure handle 0x%x, Slot %d",
475                                 le32toh(event_data->PreviousValue),
476                             le32toh(event_data->NewValue), event_data->PhysDiskNum,
477                             le16toh(event_data->PhysDiskDevHandle),
478                             le16toh(event_data->EnclosureHandle), le16toh(event_data->Slot));
479                         switch (event_data->NewValue) {
480                                 case MPI2_RAID_PD_STATE_ONLINE:
481                                 case MPI2_RAID_PD_STATE_DEGRADED:
482                                 case MPI2_RAID_PD_STATE_REBUILDING:
483                                 case MPI2_RAID_PD_STATE_OPTIMAL:
484                                 case MPI2_RAID_PD_STATE_HOT_SPARE:
485                                         targ = mpssas_find_target_by_handle(sassc, 0, 
486                                                         event_data->PhysDiskDevHandle);
487                                         if (targ) {
488                                                 if(!sc->WD_available) {
489                                                         targ->flags |= MPS_TARGET_FLAGS_RAID_COMPONENT;
490                                                         printf("%s %d: Found Target for handle 0x%x.  \n",
491                                                         __func__, __LINE__ , event_data->PhysDiskDevHandle);
492                                                 } else if ((sc->WD_available && 
493                                                         (sc->WD_hide_expose == MPS_WD_HIDE_ALWAYS)) ||
494                                                         (sc->WD_valid_config && (sc->WD_hide_expose ==
495                                                         MPS_WD_HIDE_IF_VOLUME))) {
496                                                         targ->flags |= MPS_TARGET_FLAGS_RAID_COMPONENT;
497                                                         printf("%s %d: WD: Found Target for handle 0x%x.  \n",
498                                                         __func__, __LINE__ , event_data->PhysDiskDevHandle);
499                                                 }
500                                         }               
501                                 break;
502                                 case MPI2_RAID_PD_STATE_OFFLINE:
503                                 case MPI2_RAID_PD_STATE_NOT_CONFIGURED:
504                                 case MPI2_RAID_PD_STATE_NOT_COMPATIBLE:
505                                 default:
506                                         targ = mpssas_find_target_by_handle(sassc, 0, 
507                                                         event_data->PhysDiskDevHandle);
508                                         if (targ) {
509                                                 targ->flags |= ~MPS_TARGET_FLAGS_RAID_COMPONENT;
510                                                 printf("%s %d: Found Target for handle 0x%x.  \n",
511                                                 __func__, __LINE__ , event_data->PhysDiskDevHandle);
512                                         }
513                                 break;
514                         }
515                 default:
516                         break;
517                 }
518                 break;
519         }
520         case MPI2_EVENT_IR_OPERATION_STATUS:
521         {
522                 Mpi2EventDataIrOperationStatus_t *event_data =
523                     fw_event->event_data;
524
525                 /*
526                  * Informational only.
527                  */
528                 mps_dprint(sc, MPS_EVENT, "Received IR Op Status event:\n");
529                 mps_dprint(sc, MPS_EVENT, "   RAID Operation of %d is %d "
530                     "percent complete for Volume with handle 0x%x",
531                     event_data->RAIDOperation, event_data->PercentComplete,
532                     le16toh(event_data->VolDevHandle));
533                 break;
534         }
535         case MPI2_EVENT_LOG_ENTRY_ADDED:
536         {
537                 pMpi2EventDataLogEntryAdded_t   logEntry;
538                 uint16_t                        logQualifier;
539                 uint8_t                         logCode;
540
541                 logEntry = (pMpi2EventDataLogEntryAdded_t)fw_event->event_data;
542                 logQualifier = logEntry->LogEntryQualifier;
543
544                 if (logQualifier == MPI2_WD_LOG_ENTRY) {
545                         logCode = logEntry->LogData[0];
546
547                         switch (logCode) {
548                         case MPI2_WD_SSD_THROTTLING:
549                                 printf("WarpDrive Warning: IO Throttling has "
550                                     "occurred in the WarpDrive subsystem. "
551                                     "Check WarpDrive documentation for "
552                                     "additional details\n");
553                                 break;
554                         case MPI2_WD_DRIVE_LIFE_WARN:
555                                 printf("WarpDrive Warning: Program/Erase "
556                                     "Cycles for the WarpDrive subsystem in "
557                                     "degraded range. Check WarpDrive "
558                                     "documentation for additional details\n");
559                                 break;
560                         case MPI2_WD_DRIVE_LIFE_DEAD:
561                                 printf("WarpDrive Fatal Error: There are no "
562                                     "Program/Erase Cycles for the WarpDrive "
563                                     "subsystem. The storage device will be in "
564                                     "read-only mode. Check WarpDrive "
565                                     "documentation for additional details\n");
566                                 break;
567                         case MPI2_WD_RAIL_MON_FAIL:
568                                 printf("WarpDrive Fatal Error: The Backup Rail "
569                                     "Monitor has failed on the WarpDrive "
570                                     "subsystem. Check WarpDrive documentation "
571                                     "for additional details\n");
572                                 break;
573                         default:
574                                 break;
575                         }
576                 }
577                 break;
578         }
579         case MPI2_EVENT_SAS_DEVICE_STATUS_CHANGE:
580         case MPI2_EVENT_SAS_BROADCAST_PRIMITIVE:
581         default:
582                 mps_dprint(sc, MPS_TRACE,"Unhandled event 0x%0X\n",
583                     fw_event->event);
584                 break;
585
586         }
587         mps_dprint(sc, MPS_EVENT, "(%d)->(%s) Event Free: [%x]\n",event_count,__func__, fw_event->event);
588         mpssas_fw_event_free(sc, fw_event);
589 }
590
591 void
592 mpssas_firmware_event_work(void *arg, int pending)
593 {
594         struct mps_fw_event_work *fw_event;
595         struct mps_softc *sc;
596
597         sc = (struct mps_softc *)arg;
598         mps_lock(sc);
599         while ((fw_event = TAILQ_FIRST(&sc->sassc->ev_queue)) != NULL) {
600                 TAILQ_REMOVE(&sc->sassc->ev_queue, fw_event, ev_link);
601                 mpssas_fw_work(sc, fw_event);
602         }
603         mps_unlock(sc);
604 }
605
606 static int
607 mpssas_add_device(struct mps_softc *sc, u16 handle, u8 linkrate){
608         char devstring[80];
609         struct mpssas_softc *sassc;
610         struct mpssas_target *targ;
611         Mpi2ConfigReply_t mpi_reply;
612         Mpi2SasDevicePage0_t config_page;
613         uint64_t sas_address;
614         uint64_t parent_sas_address = 0;
615         u32 device_info, parent_devinfo = 0;
616         unsigned int id;
617         int ret = 1, error = 0, i;
618         struct mpssas_lun *lun;
619         u8 is_SATA_SSD = 0;
620         struct mps_command *cm;
621
622         sassc = sc->sassc;
623         mpssas_startup_increment(sassc);
624         if ((mps_config_get_sas_device_pg0(sc, &mpi_reply, &config_page,
625              MPI2_SAS_DEVICE_PGAD_FORM_HANDLE, handle))) {
626                 printf("%s: error reading SAS device page0\n", __func__);
627                 error = ENXIO;
628                 goto out;
629         }
630
631         device_info = le32toh(config_page.DeviceInfo);
632
633         if (((device_info & MPI2_SAS_DEVICE_INFO_SMP_TARGET) == 0)
634          && (le16toh(config_page.ParentDevHandle) != 0)) {
635                 Mpi2ConfigReply_t tmp_mpi_reply;
636                 Mpi2SasDevicePage0_t parent_config_page;
637
638                 if ((mps_config_get_sas_device_pg0(sc, &tmp_mpi_reply,
639                      &parent_config_page, MPI2_SAS_DEVICE_PGAD_FORM_HANDLE,
640                      le16toh(config_page.ParentDevHandle)))) {
641                         printf("%s: error reading SAS device %#x page0\n",
642                                __func__, le16toh(config_page.ParentDevHandle));
643                 } else {
644                         parent_sas_address = parent_config_page.SASAddress.High;
645                         parent_sas_address = (parent_sas_address << 32) |
646                                 parent_config_page.SASAddress.Low;
647                         parent_devinfo = le32toh(parent_config_page.DeviceInfo);
648                 }
649         }
650         /* TODO Check proper endianess */
651         sas_address = config_page.SASAddress.High;
652         sas_address = (sas_address << 32) | config_page.SASAddress.Low;
653
654         /*
655          * Always get SATA Identify information because this is used to
656          * determine if Start/Stop Unit should be sent to the drive when the
657          * system is shutdown.
658          */
659         if (device_info & MPI2_SAS_DEVICE_INFO_SATA_DEVICE) {
660                 ret = mpssas_get_sas_address_for_sata_disk(sc, &sas_address,
661                     handle, device_info, &is_SATA_SSD);
662                 if (ret) {
663                         mps_dprint(sc, MPS_INFO, "%s: failed to get disk type "
664                             "(SSD or HDD) for SATA device with handle 0x%04x\n",
665                             __func__, handle);
666                 } else {
667                         mps_dprint(sc, MPS_INFO, "SAS Address from SATA "
668                             "device = %jx\n", sas_address);
669                 }
670         }
671
672         id = mps_mapping_get_sas_id(sc, sas_address, handle);
673         if (id == MPS_MAP_BAD_ID) {
674                 printf("failure at %s:%d/%s()! Could not get ID for device "
675                     "with handle 0x%04x\n", __FILE__, __LINE__, __func__,
676                     handle);
677                 error = ENXIO;
678                 goto out;
679         }
680
681         if (mpssas_check_id(sassc, id) != 0) {
682                 device_printf(sc->mps_dev, "Excluding target id %d\n", id);
683                 error = ENXIO;
684                 goto out;
685         }
686
687         mps_dprint(sc, MPS_MAPPING, "SAS Address from SAS device page0 = %jx\n",
688             sas_address);
689         targ = &sassc->targets[id];
690         targ->devinfo = device_info;
691         targ->devname = le32toh(config_page.DeviceName.High);
692         targ->devname = (targ->devname << 32) | 
693             le32toh(config_page.DeviceName.Low);
694         targ->encl_handle = le16toh(config_page.EnclosureHandle);
695         targ->encl_slot = le16toh(config_page.Slot);
696         targ->handle = handle;
697         targ->parent_handle = le16toh(config_page.ParentDevHandle);
698         targ->sasaddr = mps_to_u64(&config_page.SASAddress);
699         targ->parent_sasaddr = le64toh(parent_sas_address);
700         targ->parent_devinfo = parent_devinfo;
701         targ->tid = id;
702         targ->linkrate = (linkrate>>4);
703         targ->flags = 0;
704         if (is_SATA_SSD) {
705                 targ->flags = MPS_TARGET_IS_SATA_SSD;
706         }
707         TAILQ_INIT(&targ->commands);
708         TAILQ_INIT(&targ->timedout_commands);
709         while(!SLIST_EMPTY(&targ->luns)) {
710                 lun = SLIST_FIRST(&targ->luns);
711                 SLIST_REMOVE_HEAD(&targ->luns, lun_link);
712                 free(lun, M_MPT2);
713         }
714         SLIST_INIT(&targ->luns);
715
716         mps_describe_devinfo(targ->devinfo, devstring, 80);
717         mps_dprint(sc, MPS_MAPPING, "Found device <%s> <%s> <0x%04x> <%d/%d>\n",
718             devstring, mps_describe_table(mps_linkrate_names, targ->linkrate),
719             targ->handle, targ->encl_handle, targ->encl_slot);
720
721 #if __FreeBSD_version < 1000039
722         if ((sassc->flags & MPSSAS_IN_STARTUP) == 0)
723 #endif
724                 mpssas_rescan_target(sc, targ);
725         mps_dprint(sc, MPS_MAPPING, "Target id 0x%x added\n", targ->tid);
726
727         /*
728          * Check all commands to see if the SATA_ID_TIMEOUT flag has been set.
729          * If so, send a Target Reset TM to the target that was just created.
730          * An Abort Task TM should be used instead of a Target Reset, but that
731          * would be much more difficult because targets have not been fully
732          * discovered yet, and LUN's haven't been setup.  So, just reset the
733          * target instead of the LUN.
734          */
735         for (i = 1; i < sc->num_reqs; i++) {
736                 cm = &sc->commands[i];
737                 if (cm->cm_flags & MPS_CM_FLAGS_SATA_ID_TIMEOUT) {
738                         targ->timeouts++;
739                         cm->cm_state = MPS_CM_STATE_TIMEDOUT;
740
741                         if ((targ->tm = mpssas_alloc_tm(sc)) != NULL) {
742                                 mps_dprint(sc, MPS_INFO, "%s: sending Target "
743                                     "Reset for stuck SATA identify command "
744                                     "(cm = %p)\n", __func__, cm);
745                                 targ->tm->cm_targ = targ;
746                                 mpssas_send_reset(sc, targ->tm,
747                                     MPI2_SCSITASKMGMT_TASKTYPE_TARGET_RESET);
748                         } else {
749                                 mps_dprint(sc, MPS_ERROR, "Failed to allocate "
750                                     "tm for Target Reset after SATA ID command "
751                                     "timed out (cm %p)\n", cm);
752                         }
753                         /*
754                          * No need to check for more since the target is
755                          * already being reset.
756                          */
757                         break;
758                 }
759         }
760 out:
761         /*
762          * Free the commands that may not have been freed from the SATA ID call
763          */
764         for (i = 1; i < sc->num_reqs; i++) {
765                 cm = &sc->commands[i];
766                 if (cm->cm_flags & MPS_CM_FLAGS_SATA_ID_TIMEOUT) {
767                         mps_free_command(sc, cm);
768                 }
769         }
770         mpssas_startup_decrement(sassc);
771         return (error);
772         
773 }
774         
775 int
776 mpssas_get_sas_address_for_sata_disk(struct mps_softc *sc,
777     u64 *sas_address, u16 handle, u32 device_info, u8 *is_SATA_SSD)
778 {
779         Mpi2SataPassthroughReply_t mpi_reply;
780         int i, rc, try_count;
781         u32 *bufferptr;
782         union _sata_sas_address hash_address;
783         struct _ata_identify_device_data ata_identify;
784         u8 buffer[MPT2SAS_MN_LEN + MPT2SAS_SN_LEN];
785         u32 ioc_status;
786         u8 sas_status;
787
788         memset(&ata_identify, 0, sizeof(ata_identify));
789         try_count = 0;
790         do {
791                 rc = mpssas_get_sata_identify(sc, handle, &mpi_reply,
792                     (char *)&ata_identify, sizeof(ata_identify), device_info);
793                 try_count++;
794                 ioc_status = le16toh(mpi_reply.IOCStatus)
795                     & MPI2_IOCSTATUS_MASK;
796                 sas_status = mpi_reply.SASStatus;
797                 if (ioc_status != MPI2_IOCSTATUS_SUCCESS) {
798                         if (sc->spinup_wait_time > 0) {
799                                 mps_dprint(sc, MPS_INFO, "Sleeping %d seconds "
800                                     "after SATA ID error to wait for spinup\n",
801                                     sc->spinup_wait_time);
802                                 msleep(&sc->msleep_fake_chan, &sc->mps_mtx, 0,
803                                     "mpsid", sc->spinup_wait_time * hz);
804                         }
805                 }
806         } while (((rc && (rc != EWOULDBLOCK)) || ioc_status || sas_status) &&
807             (try_count < 5));
808
809         if (rc == 0 && !ioc_status && !sas_status) {
810                 mps_dprint(sc, MPS_MAPPING, "%s: got SATA identify "
811                     "successfully for handle = 0x%x with try_count = %d\n",
812                     __func__, handle, try_count);
813         } else {
814                 mps_dprint(sc, MPS_MAPPING, "%s: handle = 0x%x failed\n",
815                     __func__, handle);
816                 return -1;
817         }
818         /* Copy & byteswap the 40 byte model number to a buffer */
819         for (i = 0; i < MPT2SAS_MN_LEN; i += 2) {
820                 buffer[i] = ((u8 *)ata_identify.model_number)[i + 1];
821                 buffer[i + 1] = ((u8 *)ata_identify.model_number)[i];
822         }
823         /* Copy & byteswap the 20 byte serial number to a buffer */
824         for (i = 0; i < MPT2SAS_SN_LEN; i += 2) {
825                 buffer[MPT2SAS_MN_LEN + i] =
826                     ((u8 *)ata_identify.serial_number)[i + 1];
827                 buffer[MPT2SAS_MN_LEN + i + 1] =
828                     ((u8 *)ata_identify.serial_number)[i];
829         }
830         bufferptr = (u32 *)buffer;
831         /* There are 60 bytes to hash down to 8. 60 isn't divisible by 8,
832          * so loop through the first 56 bytes (7*8),
833          * and then add in the last dword.
834          */
835         hash_address.word.low  = 0;
836         hash_address.word.high = 0;
837         for (i = 0; (i < ((MPT2SAS_MN_LEN+MPT2SAS_SN_LEN)/8)); i++) {
838                 hash_address.word.low += *bufferptr;
839                 bufferptr++;
840                 hash_address.word.high += *bufferptr;
841                 bufferptr++;
842         }
843         /* Add the last dword */
844         hash_address.word.low += *bufferptr;
845         /* Make sure the hash doesn't start with 5, because it could clash
846          * with a SAS address. Change 5 to a D.
847          */
848         if ((hash_address.word.high & 0x000000F0) == (0x00000050))
849                 hash_address.word.high |= 0x00000080;
850         *sas_address = (u64)hash_address.wwid[0] << 56 |
851             (u64)hash_address.wwid[1] << 48 | (u64)hash_address.wwid[2] << 40 |
852             (u64)hash_address.wwid[3] << 32 | (u64)hash_address.wwid[4] << 24 |
853             (u64)hash_address.wwid[5] << 16 | (u64)hash_address.wwid[6] <<  8 |
854             (u64)hash_address.wwid[7];
855         if (ata_identify.rotational_speed == 1) {
856                 *is_SATA_SSD = 1;
857         }
858
859         return 0;
860 }
861
862 static int
863 mpssas_get_sata_identify(struct mps_softc *sc, u16 handle,
864     Mpi2SataPassthroughReply_t *mpi_reply, char *id_buffer, int sz, u32 devinfo)
865 {
866         Mpi2SataPassthroughRequest_t *mpi_request;
867         Mpi2SataPassthroughReply_t *reply;
868         struct mps_command *cm;
869         char *buffer;
870         int error = 0;
871
872         buffer = malloc( sz, M_MPT2, M_NOWAIT | M_ZERO);
873         if (!buffer)
874                 return ENOMEM;
875
876         if ((cm = mps_alloc_command(sc)) == NULL) {
877                 free(buffer, M_MPT2);
878                 return (EBUSY);
879         }
880         mpi_request = (MPI2_SATA_PASSTHROUGH_REQUEST *)cm->cm_req;
881         bzero(mpi_request,sizeof(MPI2_SATA_PASSTHROUGH_REQUEST));
882         mpi_request->Function = MPI2_FUNCTION_SATA_PASSTHROUGH;
883         mpi_request->VF_ID = 0;
884         mpi_request->DevHandle = htole16(handle);
885         mpi_request->PassthroughFlags = (MPI2_SATA_PT_REQ_PT_FLAGS_PIO |
886             MPI2_SATA_PT_REQ_PT_FLAGS_READ);
887         mpi_request->DataLength = htole32(sz);
888         mpi_request->CommandFIS[0] = 0x27;
889         mpi_request->CommandFIS[1] = 0x80;
890         mpi_request->CommandFIS[2] =  (devinfo &
891             MPI2_SAS_DEVICE_INFO_ATAPI_DEVICE) ? 0xA1 : 0xEC;
892         cm->cm_sge = &mpi_request->SGL;
893         cm->cm_sglsize = sizeof(MPI2_SGE_IO_UNION);
894         cm->cm_flags = MPS_CM_FLAGS_SGE_SIMPLE | MPS_CM_FLAGS_DATAIN;
895         cm->cm_desc.Default.RequestFlags = MPI2_REQ_DESCRIPT_FLAGS_DEFAULT_TYPE;
896         cm->cm_data = buffer;
897         cm->cm_length = htole32(sz);
898
899         /*
900          * Start a timeout counter specifically for the SATA ID command. This
901          * is used to fix a problem where the FW does not send a reply sometimes
902          * when a bad disk is in the topology. So, this is used to timeout the
903          * command so that processing can continue normally.
904          */
905         mps_dprint(sc, MPS_XINFO, "%s start timeout counter for SATA ID "
906             "command\n", __func__);
907         callout_reset(&cm->cm_callout, MPS_ATA_ID_TIMEOUT * hz,
908             mpssas_ata_id_timeout, cm);
909         error = mps_wait_command(sc, cm, 60, CAN_SLEEP);
910         mps_dprint(sc, MPS_XINFO, "%s stop timeout counter for SATA ID "
911             "command\n", __func__);
912         callout_stop(&cm->cm_callout);
913
914         reply = (Mpi2SataPassthroughReply_t *)cm->cm_reply;
915         if (error || (reply == NULL)) {
916                 /* FIXME */
917                 /*
918                  * If the request returns an error then we need to do a diag
919                  * reset
920                  */ 
921                 printf("%s: request for page completed with error %d",
922                     __func__, error);
923                 error = ENXIO;
924                 goto out;
925         }
926         bcopy(buffer, id_buffer, sz);
927         bcopy(reply, mpi_reply, sizeof(Mpi2SataPassthroughReply_t));
928         if ((le16toh(reply->IOCStatus) & MPI2_IOCSTATUS_MASK) !=
929             MPI2_IOCSTATUS_SUCCESS) {
930                 printf("%s: error reading SATA PASSTHRU; iocstatus = 0x%x\n",
931                     __func__, reply->IOCStatus);
932                 error = ENXIO;
933                 goto out;
934         }
935 out:
936         /*
937          * If the SATA_ID_TIMEOUT flag has been set for this command, don't free
938          * it.  The command will be freed after sending a target reset TM. If
939          * the command did timeout, use EWOULDBLOCK.
940          */
941         if ((cm->cm_flags & MPS_CM_FLAGS_SATA_ID_TIMEOUT) == 0)
942                 mps_free_command(sc, cm);
943         else if (error == 0)
944                 error = EWOULDBLOCK;
945         free(buffer, M_MPT2);
946         return (error);
947 }
948
949 static void
950 mpssas_ata_id_timeout(void *data)
951 {
952         struct mps_softc *sc;
953         struct mps_command *cm;
954
955         cm = (struct mps_command *)data;
956         sc = cm->cm_sc;
957         mtx_assert(&sc->mps_mtx, MA_OWNED);
958
959         mps_dprint(sc, MPS_INFO, "%s checking ATA ID command %p sc %p\n",
960             __func__, cm, sc);
961         if ((callout_pending(&cm->cm_callout)) ||
962             (!callout_active(&cm->cm_callout))) {
963                 mps_dprint(sc, MPS_INFO, "%s ATA ID command almost timed out\n",
964                     __func__);
965                 return;
966         }
967         callout_deactivate(&cm->cm_callout);
968
969         /*
970          * Run the interrupt handler to make sure it's not pending.  This
971          * isn't perfect because the command could have already completed
972          * and been re-used, though this is unlikely.
973          */
974         mps_intr_locked(sc);
975         if (cm->cm_state == MPS_CM_STATE_FREE) {
976                 mps_dprint(sc, MPS_INFO, "%s ATA ID command almost timed out\n",
977                     __func__);
978                 return;
979         }
980
981         mps_dprint(sc, MPS_INFO, "ATA ID command timeout cm %p\n", cm);
982
983         /*
984          * Send wakeup() to the sleeping thread that issued this ATA ID command.
985          * wakeup() will cause msleep to return a 0 (not EWOULDBLOCK), and this
986          * will keep reinit() from being called. This way, an Abort Task TM can
987          * be issued so that the timed out command can be cleared.  The Abort
988          * Task cannot be sent from here because the driver has not completed
989          * setting up targets.  Instead, the command is flagged so that special
990          * handling will be used to send the abort.
991          */
992         cm->cm_flags |= MPS_CM_FLAGS_SATA_ID_TIMEOUT;
993         wakeup(cm);
994 }
995
996 static int
997 mpssas_volume_add(struct mps_softc *sc, u16 handle)
998 {
999         struct mpssas_softc *sassc;
1000         struct mpssas_target *targ;
1001         u64 wwid;
1002         unsigned int id;
1003         int error = 0;
1004         struct mpssas_lun *lun;
1005
1006         sassc = sc->sassc;
1007         mpssas_startup_increment(sassc);
1008         /* wwid is endian safe */
1009         mps_config_get_volume_wwid(sc, handle, &wwid);
1010         if (!wwid) {
1011                 printf("%s: invalid WWID; cannot add volume to mapping table\n",
1012                     __func__);
1013                 error = ENXIO;
1014                 goto out;
1015         }
1016
1017         id = mps_mapping_get_raid_id(sc, wwid, handle);
1018         if (id == MPS_MAP_BAD_ID) {
1019                 printf("%s: could not get ID for volume with handle 0x%04x and "
1020                     "WWID 0x%016llx\n", __func__, handle,
1021                     (unsigned long long)wwid);
1022                 error = ENXIO;
1023                 goto out;
1024         }
1025
1026         targ = &sassc->targets[id];
1027         targ->tid = id;
1028         targ->handle = handle;
1029         targ->devname = wwid;
1030         TAILQ_INIT(&targ->commands);
1031         TAILQ_INIT(&targ->timedout_commands);
1032         while(!SLIST_EMPTY(&targ->luns)) {
1033                 lun = SLIST_FIRST(&targ->luns);
1034                 SLIST_REMOVE_HEAD(&targ->luns, lun_link);
1035                 free(lun, M_MPT2);
1036         }
1037         SLIST_INIT(&targ->luns);
1038 #if __FreeBSD_version < 1000039
1039         if ((sassc->flags & MPSSAS_IN_STARTUP) == 0)
1040 #endif
1041                 mpssas_rescan_target(sc, targ);
1042         mps_dprint(sc, MPS_MAPPING, "RAID target id %d added (WWID = 0x%jx)\n",
1043             targ->tid, wwid);
1044 out:
1045         mpssas_startup_decrement(sassc);
1046         return (error);
1047 }
1048
1049 /**
1050  * mpssas_SSU_to_SATA_devices 
1051  * @sc: per adapter object
1052  *
1053  * Looks through the target list and issues a StartStopUnit SCSI command to each
1054  * SATA direct-access device.  This helps to ensure that data corruption is
1055  * avoided when the system is being shut down.  This must be called after the IR
1056  * System Shutdown RAID Action is sent if in IR mode.
1057  *
1058  * Return nothing.
1059  */
1060 static void
1061 mpssas_SSU_to_SATA_devices(struct mps_softc *sc)
1062 {
1063         struct mpssas_softc *sassc = sc->sassc;
1064         union ccb *ccb;
1065         path_id_t pathid = cam_sim_path(sassc->sim);
1066         target_id_t targetid;
1067         struct mpssas_target *target;
1068         char path_str[64];
1069         struct timeval cur_time, start_time;
1070
1071         /*
1072          * For each target, issue a StartStopUnit command to stop the device.
1073          */
1074         sc->SSU_started = TRUE;
1075         sc->SSU_refcount = 0;
1076         for (targetid = 0; targetid < sc->facts->MaxTargets; targetid++) {
1077                 target = &sassc->targets[targetid];
1078                 if (target->handle == 0x0) {
1079                         continue;
1080                 }
1081
1082                 ccb = xpt_alloc_ccb_nowait();
1083                 if (ccb == NULL) {
1084                         mps_dprint(sc, MPS_FAULT, "Unable to alloc CCB to stop "
1085                             "unit.\n");
1086                         return;
1087                 }
1088
1089                 /*
1090                  * The stop_at_shutdown flag will be set if this device is
1091                  * a SATA direct-access end device.
1092                  */
1093                 if (target->stop_at_shutdown) {
1094                         if (xpt_create_path(&ccb->ccb_h.path,
1095                             xpt_periph, pathid, targetid,
1096                             CAM_LUN_WILDCARD) != CAM_REQ_CMP) {
1097                                 mps_dprint(sc, MPS_FAULT, "Unable to create "
1098                                     "LUN path to stop unit.\n");
1099                                 xpt_free_ccb(ccb);
1100                                 return;
1101                         }
1102                         xpt_path_string(ccb->ccb_h.path, path_str,
1103                             sizeof(path_str));
1104
1105                         mps_dprint(sc, MPS_INFO, "Sending StopUnit: path %s "
1106                             "handle %d\n", path_str, target->handle);
1107                         
1108                         /*
1109                          * Issue a START STOP UNIT command for the target.
1110                          * Increment the SSU counter to be used to count the
1111                          * number of required replies.
1112                          */
1113                         mps_dprint(sc, MPS_INFO, "Incrementing SSU count\n");
1114                         sc->SSU_refcount++;
1115                         ccb->ccb_h.target_id =
1116                             xpt_path_target_id(ccb->ccb_h.path);
1117                         ccb->ccb_h.ppriv_ptr1 = sassc;
1118                         scsi_start_stop(&ccb->csio,
1119                             /*retries*/0,
1120                             mpssas_stop_unit_done,
1121                             MSG_SIMPLE_Q_TAG,
1122                             /*start*/FALSE,
1123                             /*load/eject*/0,
1124                             /*immediate*/FALSE,
1125                             MPS_SENSE_LEN,
1126                             /*timeout*/10000);
1127                         xpt_action(ccb);
1128                 }
1129         }
1130
1131         /*
1132          * Wait until all of the SSU commands have completed or time has
1133          * expired (60 seconds).  Pause for 100ms each time through.  If any
1134          * command times out, the target will be reset in the SCSI command
1135          * timeout routine.
1136          */
1137         getmicrotime(&start_time);
1138         while (sc->SSU_refcount) {
1139                 pause("mpswait", hz/10);
1140                 
1141                 getmicrotime(&cur_time);
1142                 if ((cur_time.tv_sec - start_time.tv_sec) > 60) {
1143                         mps_dprint(sc, MPS_FAULT, "Time has expired waiting "
1144                             "for SSU commands to complete.\n");
1145                         break;
1146                 }
1147         }
1148 }
1149
1150 static void
1151 mpssas_stop_unit_done(struct cam_periph *periph, union ccb *done_ccb)
1152 {
1153         struct mpssas_softc *sassc;
1154         char path_str[64];
1155
1156         sassc = (struct mpssas_softc *)done_ccb->ccb_h.ppriv_ptr1;
1157
1158         xpt_path_string(done_ccb->ccb_h.path, path_str, sizeof(path_str));
1159         mps_dprint(sassc->sc, MPS_INFO, "Completing stop unit for %s\n",
1160             path_str);
1161
1162         if (done_ccb == NULL)
1163                 return;
1164
1165         /*
1166          * Nothing more to do except free the CCB and path.  If the command
1167          * timed out, an abort reset, then target reset will be issued during
1168          * the SCSI Command process.
1169          */
1170         xpt_free_path(done_ccb->ccb_h.path);
1171         xpt_free_ccb(done_ccb);
1172 }
1173
1174 /**
1175  * mpssas_ir_shutdown - IR shutdown notification
1176  * @sc: per adapter object
1177  *
1178  * Sending RAID Action to alert the Integrated RAID subsystem of the IOC that
1179  * the host system is shutting down.
1180  *
1181  * Return nothing.
1182  */
1183 void
1184 mpssas_ir_shutdown(struct mps_softc *sc)
1185 {
1186         u16 volume_mapping_flags;
1187         u16 ioc_pg8_flags = le16toh(sc->ioc_pg8.Flags);
1188         struct dev_mapping_table *mt_entry;
1189         u32 start_idx, end_idx;
1190         unsigned int id, found_volume = 0;
1191         struct mps_command *cm;
1192         Mpi2RaidActionRequest_t *action;
1193         target_id_t targetid;
1194         struct mpssas_target *target;
1195
1196         mps_dprint(sc, MPS_TRACE, "%s\n", __func__);
1197
1198         /* is IR firmware build loaded? */
1199         if (!sc->ir_firmware)
1200                 goto out;
1201
1202         /* are there any volumes?  Look at IR target IDs. */
1203         // TODO-later, this should be looked up in the RAID config structure
1204         // when it is implemented.
1205         volume_mapping_flags = le16toh(sc->ioc_pg8.IRVolumeMappingFlags) &
1206             MPI2_IOCPAGE8_IRFLAGS_MASK_VOLUME_MAPPING_MODE;
1207         if (volume_mapping_flags == MPI2_IOCPAGE8_IRFLAGS_LOW_VOLUME_MAPPING) {
1208                 start_idx = 0;
1209                 if (ioc_pg8_flags & MPI2_IOCPAGE8_FLAGS_RESERVED_TARGETID_0)
1210                         start_idx = 1;
1211         } else
1212                 start_idx = sc->max_devices - sc->max_volumes;
1213         end_idx = start_idx + sc->max_volumes - 1;
1214
1215         for (id = start_idx; id < end_idx; id++) {
1216                 mt_entry = &sc->mapping_table[id];
1217                 if ((mt_entry->physical_id != 0) &&
1218                     (mt_entry->missing_count == 0)) {
1219                         found_volume = 1;
1220                         break;
1221                 }
1222         }
1223
1224         if (!found_volume)
1225                 goto out;
1226
1227         if ((cm = mps_alloc_command(sc)) == NULL) {
1228                 printf("%s: command alloc failed\n", __func__);
1229                 goto out;
1230         }
1231
1232         action = (MPI2_RAID_ACTION_REQUEST *)cm->cm_req;
1233         action->Function = MPI2_FUNCTION_RAID_ACTION;
1234         action->Action = MPI2_RAID_ACTION_SYSTEM_SHUTDOWN_INITIATED;
1235         cm->cm_desc.Default.RequestFlags = MPI2_REQ_DESCRIPT_FLAGS_DEFAULT_TYPE;
1236         mps_lock(sc);
1237         mps_wait_command(sc, cm, 5, CAN_SLEEP);
1238         mps_unlock(sc);
1239
1240         /*
1241          * Don't check for reply, just leave.
1242          */
1243         if (cm)
1244                 mps_free_command(sc, cm);
1245
1246 out:
1247         /*
1248          * All of the targets must have the correct value set for
1249          * 'stop_at_shutdown' for the current 'enable_ssu' sysctl variable.
1250          *
1251          * The possible values for the 'enable_ssu' variable are:
1252          * 0: disable to SSD and HDD
1253          * 1: disable only to HDD (default)
1254          * 2: disable only to SSD
1255          * 3: enable to SSD and HDD
1256          * anything else will default to 1.
1257          */
1258         for (targetid = 0; targetid < sc->facts->MaxTargets; targetid++) {
1259                 target = &sc->sassc->targets[targetid];
1260                 if (target->handle == 0x0) {
1261                         continue;
1262                 }
1263
1264                 if (target->supports_SSU) {
1265                         switch (sc->enable_ssu) {
1266                         case MPS_SSU_DISABLE_SSD_DISABLE_HDD:
1267                                 target->stop_at_shutdown = FALSE;
1268                                 break;
1269                         case MPS_SSU_DISABLE_SSD_ENABLE_HDD:
1270                                 target->stop_at_shutdown = TRUE;
1271                                 if (target->flags & MPS_TARGET_IS_SATA_SSD) {
1272                                         target->stop_at_shutdown = FALSE;
1273                                 }
1274                                 break;
1275                         case MPS_SSU_ENABLE_SSD_ENABLE_HDD:
1276                                 target->stop_at_shutdown = TRUE;
1277                                 break;
1278                         case MPS_SSU_ENABLE_SSD_DISABLE_HDD:
1279                         default:
1280                                 target->stop_at_shutdown = TRUE;
1281                                 if ((target->flags &
1282                                     MPS_TARGET_IS_SATA_SSD) == 0) {
1283                                         target->stop_at_shutdown = FALSE;
1284                                 }
1285                                 break;
1286                         }
1287                 }
1288         }
1289         mpssas_SSU_to_SATA_devices(sc);
1290 }