xref: /freebsd/sys/dev/mpr/mpr_sas_lsi.c (revision a0b9e2e854027e6ff61fb075a1309dbc71c42b54)
1 /*-
2  * Copyright (c) 2011-2015 LSI Corp.
3  * Copyright (c) 2013-2016 Avago Technologies
4  * Copyright 2000-2020 Broadcom Inc.
5  * All rights reserved.
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, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
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
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  *
28  * Broadcom Inc. (LSI) MPT-Fusion Host Adapter FreeBSD
29  */
30 
31 #include <sys/cdefs.h>
32 __FBSDID("$FreeBSD$");
33 
34 /* Communications core for Avago Technologies (LSI) MPT3 */
35 
36 /* TODO Move headers to mprvar */
37 #include <sys/types.h>
38 #include <sys/param.h>
39 #include <sys/systm.h>
40 #include <sys/kernel.h>
41 #include <sys/selinfo.h>
42 #include <sys/module.h>
43 #include <sys/bus.h>
44 #include <sys/conf.h>
45 #include <sys/bio.h>
46 #include <sys/malloc.h>
47 #include <sys/uio.h>
48 #include <sys/sysctl.h>
49 #include <sys/endian.h>
50 #include <sys/proc.h>
51 #include <sys/queue.h>
52 #include <sys/kthread.h>
53 #include <sys/taskqueue.h>
54 #include <sys/sbuf.h>
55 #include <sys/reboot.h>
56 
57 #include <machine/bus.h>
58 #include <machine/resource.h>
59 #include <sys/rman.h>
60 
61 #include <machine/stdarg.h>
62 
63 #include <cam/cam.h>
64 #include <cam/cam_ccb.h>
65 #include <cam/cam_debug.h>
66 #include <cam/cam_sim.h>
67 #include <cam/cam_xpt_sim.h>
68 #include <cam/cam_xpt_periph.h>
69 #include <cam/cam_periph.h>
70 #include <cam/scsi/scsi_all.h>
71 #include <cam/scsi/scsi_message.h>
72 
73 #include <dev/mpr/mpi/mpi2_type.h>
74 #include <dev/mpr/mpi/mpi2.h>
75 #include <dev/mpr/mpi/mpi2_ioc.h>
76 #include <dev/mpr/mpi/mpi2_sas.h>
77 #include <dev/mpr/mpi/mpi2_pci.h>
78 #include <dev/mpr/mpi/mpi2_cnfg.h>
79 #include <dev/mpr/mpi/mpi2_init.h>
80 #include <dev/mpr/mpi/mpi2_raid.h>
81 #include <dev/mpr/mpi/mpi2_tool.h>
82 #include <dev/mpr/mpr_ioctl.h>
83 #include <dev/mpr/mprvar.h>
84 #include <dev/mpr/mpr_table.h>
85 #include <dev/mpr/mpr_sas.h>
86 
87 /* For Hashed SAS Address creation for SATA Drives */
88 #define MPT2SAS_SN_LEN 20
89 #define MPT2SAS_MN_LEN 40
90 
91 struct mpr_fw_event_work {
92 	u16			event;
93 	void			*event_data;
94 	TAILQ_ENTRY(mpr_fw_event_work)	ev_link;
95 };
96 
97 union _sata_sas_address {
98 	u8 wwid[8];
99 	struct {
100 		u32 high;
101 		u32 low;
102 	} word;
103 };
104 
105 /*
106  * define the IDENTIFY DEVICE structure
107  */
108 struct _ata_identify_device_data {
109 	u16 reserved1[10];	/* 0-9 */
110 	u16 serial_number[10];	/* 10-19 */
111 	u16 reserved2[7];	/* 20-26 */
112 	u16 model_number[20];	/* 27-46*/
113 	u16 reserved3[170];	/* 47-216 */
114 	u16 rotational_speed;	/* 217 */
115 	u16 reserved4[38];	/* 218-255 */
116 };
117 static u32 event_count;
118 static void mprsas_fw_work(struct mpr_softc *sc,
119     struct mpr_fw_event_work *fw_event);
120 static void mprsas_fw_event_free(struct mpr_softc *,
121     struct mpr_fw_event_work *);
122 static int mprsas_add_device(struct mpr_softc *sc, u16 handle, u8 linkrate);
123 static int mprsas_add_pcie_device(struct mpr_softc *sc, u16 handle,
124     u8 linkrate);
125 static int mprsas_get_sata_identify(struct mpr_softc *sc, u16 handle,
126     Mpi2SataPassthroughReply_t *mpi_reply, char *id_buffer, int sz,
127     u32 devinfo);
128 static void mprsas_ata_id_timeout(struct mpr_softc *, struct mpr_command *);
129 int mprsas_get_sas_address_for_sata_disk(struct mpr_softc *sc,
130     u64 *sas_address, u16 handle, u32 device_info, u8 *is_SATA_SSD);
131 static int mprsas_volume_add(struct mpr_softc *sc,
132     u16 handle);
133 static void mprsas_SSU_to_SATA_devices(struct mpr_softc *sc, int howto);
134 static void mprsas_stop_unit_done(struct cam_periph *periph,
135     union ccb *done_ccb);
136 
137 void
138 mprsas_evt_handler(struct mpr_softc *sc, uintptr_t data,
139     MPI2_EVENT_NOTIFICATION_REPLY *event)
140 {
141 	struct mpr_fw_event_work *fw_event;
142 	u16 sz;
143 
144 	mpr_dprint(sc, MPR_TRACE, "%s\n", __func__);
145 	MPR_DPRINT_EVENT(sc, sas, event);
146 	mprsas_record_event(sc, event);
147 
148 	fw_event = malloc(sizeof(struct mpr_fw_event_work), M_MPR,
149 	     M_ZERO|M_NOWAIT);
150 	if (!fw_event) {
151 		printf("%s: allocate failed for fw_event\n", __func__);
152 		return;
153 	}
154 	sz = le16toh(event->EventDataLength) * 4;
155 	fw_event->event_data = malloc(sz, M_MPR, M_ZERO|M_NOWAIT);
156 	if (!fw_event->event_data) {
157 		printf("%s: allocate failed for event_data\n", __func__);
158 		free(fw_event, M_MPR);
159 		return;
160 	}
161 
162 	bcopy(event->EventData, fw_event->event_data, sz);
163 	fw_event->event = event->Event;
164 	if ((event->Event == MPI2_EVENT_SAS_TOPOLOGY_CHANGE_LIST ||
165 	    event->Event == MPI2_EVENT_PCIE_TOPOLOGY_CHANGE_LIST ||
166 	    event->Event == MPI2_EVENT_SAS_ENCL_DEVICE_STATUS_CHANGE ||
167 	    event->Event == MPI2_EVENT_IR_CONFIGURATION_CHANGE_LIST) &&
168 	    sc->track_mapping_events)
169 		sc->pending_map_events++;
170 
171 	/*
172 	 * When wait_for_port_enable flag is set, make sure that all the events
173 	 * are processed. Increment the startup_refcount and decrement it after
174 	 * events are processed.
175 	 */
176 	if ((event->Event == MPI2_EVENT_SAS_TOPOLOGY_CHANGE_LIST ||
177 	    event->Event == MPI2_EVENT_PCIE_TOPOLOGY_CHANGE_LIST ||
178 	    event->Event == MPI2_EVENT_IR_CONFIGURATION_CHANGE_LIST) &&
179 	    sc->wait_for_port_enable)
180 		mprsas_startup_increment(sc->sassc);
181 
182 	TAILQ_INSERT_TAIL(&sc->sassc->ev_queue, fw_event, ev_link);
183 	taskqueue_enqueue(sc->sassc->ev_tq, &sc->sassc->ev_task);
184 }
185 
186 static void
187 mprsas_fw_event_free(struct mpr_softc *sc, struct mpr_fw_event_work *fw_event)
188 {
189 
190 	free(fw_event->event_data, M_MPR);
191 	free(fw_event, M_MPR);
192 }
193 
194 /**
195  * _mpr_fw_work - delayed task for processing firmware events
196  * @sc: per adapter object
197  * @fw_event: The fw_event_work object
198  * Context: user.
199  *
200  * Return nothing.
201  */
202 static void
203 mprsas_fw_work(struct mpr_softc *sc, struct mpr_fw_event_work *fw_event)
204 {
205 	struct mprsas_softc *sassc;
206 	sassc = sc->sassc;
207 
208 	mpr_dprint(sc, MPR_EVENT, "(%d)->(%s) Working on  Event: [%x]\n",
209 	    event_count++, __func__, fw_event->event);
210 	switch (fw_event->event) {
211 	case MPI2_EVENT_SAS_TOPOLOGY_CHANGE_LIST:
212 	{
213 		MPI2_EVENT_DATA_SAS_TOPOLOGY_CHANGE_LIST *data;
214 		MPI2_EVENT_SAS_TOPO_PHY_ENTRY *phy;
215 		uint8_t i;
216 
217 		data = (MPI2_EVENT_DATA_SAS_TOPOLOGY_CHANGE_LIST *)
218 		    fw_event->event_data;
219 
220 		mpr_mapping_topology_change_event(sc, fw_event->event_data);
221 
222 		for (i = 0; i < data->NumEntries; i++) {
223 			phy = &data->PHY[i];
224 			switch (phy->PhyStatus & MPI2_EVENT_SAS_TOPO_RC_MASK) {
225 			case MPI2_EVENT_SAS_TOPO_RC_TARG_ADDED:
226 				if (mprsas_add_device(sc,
227 				    le16toh(phy->AttachedDevHandle),
228 				    phy->LinkRate)) {
229 					mpr_dprint(sc, MPR_ERROR, "%s: "
230 					    "failed to add device with handle "
231 					    "0x%x\n", __func__,
232 					    le16toh(phy->AttachedDevHandle));
233 					mprsas_prepare_remove(sassc, le16toh(
234 					    phy->AttachedDevHandle));
235 				}
236 				break;
237 			case MPI2_EVENT_SAS_TOPO_RC_TARG_NOT_RESPONDING:
238 				mprsas_prepare_remove(sassc, le16toh(
239 				    phy->AttachedDevHandle));
240 				break;
241 			case MPI2_EVENT_SAS_TOPO_RC_PHY_CHANGED:
242 			case MPI2_EVENT_SAS_TOPO_RC_NO_CHANGE:
243 			case MPI2_EVENT_SAS_TOPO_RC_DELAY_NOT_RESPONDING:
244 			default:
245 				break;
246 			}
247 		}
248 		/*
249 		 * refcount was incremented for this event in
250 		 * mprsas_evt_handler.  Decrement it here because the event has
251 		 * been processed.
252 		 */
253 		mprsas_startup_decrement(sassc);
254 		break;
255 	}
256 	case MPI2_EVENT_SAS_DISCOVERY:
257 	{
258 		MPI2_EVENT_DATA_SAS_DISCOVERY *data;
259 
260 		data = (MPI2_EVENT_DATA_SAS_DISCOVERY *)fw_event->event_data;
261 
262 		if (data->ReasonCode & MPI2_EVENT_SAS_DISC_RC_STARTED)
263 			mpr_dprint(sc, MPR_TRACE,"SAS discovery start event\n");
264 		if (data->ReasonCode & MPI2_EVENT_SAS_DISC_RC_COMPLETED) {
265 			mpr_dprint(sc, MPR_TRACE,"SAS discovery stop event\n");
266 			sassc->flags &= ~MPRSAS_IN_DISCOVERY;
267 			mprsas_discovery_end(sassc);
268 		}
269 		break;
270 	}
271 	case MPI2_EVENT_SAS_ENCL_DEVICE_STATUS_CHANGE:
272 	{
273 		Mpi2EventDataSasEnclDevStatusChange_t *data;
274 		data = (Mpi2EventDataSasEnclDevStatusChange_t *)
275 		    fw_event->event_data;
276 		mpr_mapping_enclosure_dev_status_change_event(sc,
277 		    fw_event->event_data);
278 		break;
279 	}
280 	case MPI2_EVENT_IR_CONFIGURATION_CHANGE_LIST:
281 	{
282 		Mpi2EventIrConfigElement_t *element;
283 		int i;
284 		u8 foreign_config, reason;
285 		u16 elementType;
286 		Mpi2EventDataIrConfigChangeList_t *event_data;
287 		struct mprsas_target *targ;
288 		unsigned int id;
289 
290 		event_data = fw_event->event_data;
291 		foreign_config = (le32toh(event_data->Flags) &
292 		    MPI2_EVENT_IR_CHANGE_FLAGS_FOREIGN_CONFIG) ? 1 : 0;
293 
294 		element =
295 		    (Mpi2EventIrConfigElement_t *)&event_data->ConfigElement[0];
296 		id = mpr_mapping_get_raid_tid_from_handle(sc,
297 		    element->VolDevHandle);
298 
299 		mpr_mapping_ir_config_change_event(sc, event_data);
300 		for (i = 0; i < event_data->NumElements; i++, element++) {
301 			reason = element->ReasonCode;
302 			elementType = le16toh(element->ElementFlags) &
303 			    MPI2_EVENT_IR_CHANGE_EFLAGS_ELEMENT_TYPE_MASK;
304 			/*
305 			 * check for element type of Phys Disk or Hot Spare
306 			 */
307 			if ((elementType !=
308 			    MPI2_EVENT_IR_CHANGE_EFLAGS_VOLPHYSDISK_ELEMENT)
309 			    && (elementType !=
310 			    MPI2_EVENT_IR_CHANGE_EFLAGS_HOTSPARE_ELEMENT))
311 				// do next element
312 				goto skip_fp_send;
313 
314 			/*
315 			 * check for reason of Hide, Unhide, PD Created, or PD
316 			 * Deleted
317 			 */
318 			if ((reason != MPI2_EVENT_IR_CHANGE_RC_HIDE) &&
319 			    (reason != MPI2_EVENT_IR_CHANGE_RC_UNHIDE) &&
320 			    (reason != MPI2_EVENT_IR_CHANGE_RC_PD_CREATED) &&
321 			    (reason != MPI2_EVENT_IR_CHANGE_RC_PD_DELETED))
322 				goto skip_fp_send;
323 
324 			// check for a reason of Hide or PD Created
325 			if ((reason == MPI2_EVENT_IR_CHANGE_RC_HIDE) ||
326 			    (reason == MPI2_EVENT_IR_CHANGE_RC_PD_CREATED))
327 			{
328 				// build RAID Action message
329 				Mpi2RaidActionRequest_t	*action;
330 				Mpi2RaidActionReply_t *reply = NULL;
331 				struct mpr_command *cm;
332 				int error = 0;
333 				if ((cm = mpr_alloc_command(sc)) == NULL) {
334 					printf("%s: command alloc failed\n",
335 					    __func__);
336 					return;
337 				}
338 
339 				mpr_dprint(sc, MPR_EVENT, "Sending FP action "
340 				    "from "
341 				    "MPI2_EVENT_IR_CONFIGURATION_CHANGE_LIST "
342 				    ":\n");
343 				action = (MPI2_RAID_ACTION_REQUEST *)cm->cm_req;
344 				action->Function = MPI2_FUNCTION_RAID_ACTION;
345 				action->Action =
346 				    MPI2_RAID_ACTION_PHYSDISK_HIDDEN;
347 				action->PhysDiskNum = element->PhysDiskNum;
348 				cm->cm_desc.Default.RequestFlags =
349 				    MPI2_REQ_DESCRIPT_FLAGS_DEFAULT_TYPE;
350 				error = mpr_request_polled(sc, &cm);
351 				if (cm != NULL)
352 					reply = (Mpi2RaidActionReply_t *)
353 					    cm->cm_reply;
354 				if (error || (reply == NULL)) {
355 					/* FIXME */
356 					/*
357 					 * If the poll returns error then we
358 					 * need to do diag reset
359 					 */
360 					printf("%s: poll for page completed "
361 					    "with error %d", __func__, error);
362 				}
363 				if (reply && (le16toh(reply->IOCStatus) &
364 				    MPI2_IOCSTATUS_MASK) !=
365 				    MPI2_IOCSTATUS_SUCCESS) {
366 					mpr_dprint(sc, MPR_ERROR, "%s: error "
367 					    "sending RaidActionPage; "
368 					    "iocstatus = 0x%x\n", __func__,
369 					    le16toh(reply->IOCStatus));
370 				}
371 
372 				if (cm)
373 					mpr_free_command(sc, cm);
374 			}
375 skip_fp_send:
376 			mpr_dprint(sc, MPR_EVENT, "Received "
377 			    "MPI2_EVENT_IR_CONFIGURATION_CHANGE_LIST Reason "
378 			    "code %x:\n", element->ReasonCode);
379 			switch (element->ReasonCode) {
380 			case MPI2_EVENT_IR_CHANGE_RC_VOLUME_CREATED:
381 			case MPI2_EVENT_IR_CHANGE_RC_ADDED:
382 				if (!foreign_config) {
383 					if (mprsas_volume_add(sc,
384 					    le16toh(element->VolDevHandle))) {
385 						printf("%s: failed to add RAID "
386 						    "volume with handle 0x%x\n",
387 						    __func__, le16toh(element->
388 						    VolDevHandle));
389 					}
390 				}
391 				break;
392 			case MPI2_EVENT_IR_CHANGE_RC_VOLUME_DELETED:
393 			case MPI2_EVENT_IR_CHANGE_RC_REMOVED:
394 				/*
395 				 * Rescan after volume is deleted or removed.
396 				 */
397 				if (!foreign_config) {
398 					if (id == MPR_MAP_BAD_ID) {
399 						printf("%s: could not get ID "
400 						    "for volume with handle "
401 						    "0x%04x\n", __func__,
402 						    le16toh(element->
403 						    VolDevHandle));
404 						break;
405 					}
406 
407 					targ = &sassc->targets[id];
408 					targ->handle = 0x0;
409 					targ->encl_slot = 0x0;
410 					targ->encl_handle = 0x0;
411 					targ->encl_level_valid = 0x0;
412 					targ->encl_level = 0x0;
413 					targ->connector_name[0] = ' ';
414 					targ->connector_name[1] = ' ';
415 					targ->connector_name[2] = ' ';
416 					targ->connector_name[3] = ' ';
417 					targ->exp_dev_handle = 0x0;
418 					targ->phy_num = 0x0;
419 					targ->linkrate = 0x0;
420 					mprsas_rescan_target(sc, targ);
421 					printf("RAID target id 0x%x removed\n",
422 					    targ->tid);
423 				}
424 				break;
425 			case MPI2_EVENT_IR_CHANGE_RC_PD_CREATED:
426 			case MPI2_EVENT_IR_CHANGE_RC_HIDE:
427 				/*
428 				 * Phys Disk of a volume has been created.  Hide
429 				 * it from the OS.
430 				 */
431 				targ = mprsas_find_target_by_handle(sassc, 0,
432 				    element->PhysDiskDevHandle);
433 				if (targ == NULL)
434 					break;
435 				targ->flags |= MPR_TARGET_FLAGS_RAID_COMPONENT;
436 				mprsas_rescan_target(sc, targ);
437 				break;
438 			case MPI2_EVENT_IR_CHANGE_RC_PD_DELETED:
439 				/*
440 				 * Phys Disk of a volume has been deleted.
441 				 * Expose it to the OS.
442 				 */
443 				if (mprsas_add_device(sc,
444 				    le16toh(element->PhysDiskDevHandle), 0)) {
445 					printf("%s: failed to add device with "
446 					    "handle 0x%x\n", __func__,
447 					    le16toh(element->
448 					    PhysDiskDevHandle));
449 					mprsas_prepare_remove(sassc,
450 					    le16toh(element->
451 					    PhysDiskDevHandle));
452 				}
453 				break;
454 			}
455 		}
456 		/*
457 		 * refcount was incremented for this event in
458 		 * mprsas_evt_handler.  Decrement it here because the event has
459 		 * been processed.
460 		 */
461 		mprsas_startup_decrement(sassc);
462 		break;
463 	}
464 	case MPI2_EVENT_IR_VOLUME:
465 	{
466 		Mpi2EventDataIrVolume_t *event_data = fw_event->event_data;
467 
468 		/*
469 		 * Informational only.
470 		 */
471 		mpr_dprint(sc, MPR_EVENT, "Received IR Volume event:\n");
472 		switch (event_data->ReasonCode) {
473 		case MPI2_EVENT_IR_VOLUME_RC_SETTINGS_CHANGED:
474   			mpr_dprint(sc, MPR_EVENT, "   Volume Settings "
475   			    "changed from 0x%x to 0x%x for Volome with "
476  			    "handle 0x%x", le32toh(event_data->PreviousValue),
477  			    le32toh(event_data->NewValue),
478  			    le16toh(event_data->VolDevHandle));
479 			break;
480 		case MPI2_EVENT_IR_VOLUME_RC_STATUS_FLAGS_CHANGED:
481   			mpr_dprint(sc, MPR_EVENT, "   Volume Status "
482   			    "changed from 0x%x to 0x%x for Volome with "
483  			    "handle 0x%x", le32toh(event_data->PreviousValue),
484  			    le32toh(event_data->NewValue),
485  			    le16toh(event_data->VolDevHandle));
486 			break;
487 		case MPI2_EVENT_IR_VOLUME_RC_STATE_CHANGED:
488   			mpr_dprint(sc, MPR_EVENT, "   Volume State "
489   			    "changed from 0x%x to 0x%x for Volome with "
490  			    "handle 0x%x", le32toh(event_data->PreviousValue),
491  			    le32toh(event_data->NewValue),
492  			    le16toh(event_data->VolDevHandle));
493 				u32 state;
494 				struct mprsas_target *targ;
495 				state = le32toh(event_data->NewValue);
496 				switch (state) {
497 				case MPI2_RAID_VOL_STATE_MISSING:
498 				case MPI2_RAID_VOL_STATE_FAILED:
499 					mprsas_prepare_volume_remove(sassc,
500 					    event_data->VolDevHandle);
501 					break;
502 
503 				case MPI2_RAID_VOL_STATE_ONLINE:
504 				case MPI2_RAID_VOL_STATE_DEGRADED:
505 				case MPI2_RAID_VOL_STATE_OPTIMAL:
506 					targ =
507 					    mprsas_find_target_by_handle(sassc,
508 					    0, event_data->VolDevHandle);
509 					if (targ) {
510 						printf("%s %d: Volume handle "
511 						    "0x%x is already added \n",
512 						    __func__, __LINE__,
513 						    event_data->VolDevHandle);
514 						break;
515 					}
516 					if (mprsas_volume_add(sc,
517 					    le16toh(event_data->
518 					    VolDevHandle))) {
519 						printf("%s: failed to add RAID "
520 						    "volume with handle 0x%x\n",
521 						    __func__, le16toh(
522 						    event_data->VolDevHandle));
523 					}
524 					break;
525 				default:
526 					break;
527 				}
528 			break;
529 		default:
530 			break;
531 		}
532 		break;
533 	}
534 	case MPI2_EVENT_IR_PHYSICAL_DISK:
535 	{
536 		Mpi2EventDataIrPhysicalDisk_t *event_data =
537 		    fw_event->event_data;
538 		struct mprsas_target *targ;
539 
540 		/*
541 		 * Informational only.
542 		 */
543 		mpr_dprint(sc, MPR_EVENT, "Received IR Phys Disk event:\n");
544 		switch (event_data->ReasonCode) {
545 		case MPI2_EVENT_IR_PHYSDISK_RC_SETTINGS_CHANGED:
546   			mpr_dprint(sc, MPR_EVENT, "   Phys Disk Settings "
547   			    "changed from 0x%x to 0x%x for Phys Disk Number "
548   			    "%d and handle 0x%x at Enclosure handle 0x%x, Slot "
549  			    "%d", le32toh(event_data->PreviousValue),
550  			    le32toh(event_data->NewValue),
551 			    event_data->PhysDiskNum,
552  			    le16toh(event_data->PhysDiskDevHandle),
553  			    le16toh(event_data->EnclosureHandle),
554 			    le16toh(event_data->Slot));
555 			break;
556 		case MPI2_EVENT_IR_PHYSDISK_RC_STATUS_FLAGS_CHANGED:
557   			mpr_dprint(sc, MPR_EVENT, "   Phys Disk Status changed "
558   			    "from 0x%x to 0x%x for Phys Disk Number %d and "
559   			    "handle 0x%x at Enclosure handle 0x%x, Slot %d",
560  			    le32toh(event_data->PreviousValue),
561  			    le32toh(event_data->NewValue),
562 			    event_data->PhysDiskNum,
563  			    le16toh(event_data->PhysDiskDevHandle),
564  			    le16toh(event_data->EnclosureHandle),
565 			    le16toh(event_data->Slot));
566 			break;
567 		case MPI2_EVENT_IR_PHYSDISK_RC_STATE_CHANGED:
568   			mpr_dprint(sc, MPR_EVENT, "   Phys Disk State changed "
569   			    "from 0x%x to 0x%x for Phys Disk Number %d and "
570   			    "handle 0x%x at Enclosure handle 0x%x, Slot %d",
571  			    le32toh(event_data->PreviousValue),
572  			    le32toh(event_data->NewValue),
573 			    event_data->PhysDiskNum,
574  			    le16toh(event_data->PhysDiskDevHandle),
575  			    le16toh(event_data->EnclosureHandle),
576 			    le16toh(event_data->Slot));
577 			switch (event_data->NewValue) {
578 				case MPI2_RAID_PD_STATE_ONLINE:
579 				case MPI2_RAID_PD_STATE_DEGRADED:
580 				case MPI2_RAID_PD_STATE_REBUILDING:
581 				case MPI2_RAID_PD_STATE_OPTIMAL:
582 				case MPI2_RAID_PD_STATE_HOT_SPARE:
583 					targ = mprsas_find_target_by_handle(
584 					    sassc, 0,
585 					    event_data->PhysDiskDevHandle);
586 					if (targ) {
587 						targ->flags |=
588 						    MPR_TARGET_FLAGS_RAID_COMPONENT;
589 						printf("%s %d: Found Target "
590 						    "for handle 0x%x.\n",
591 						    __func__, __LINE__ ,
592 						    event_data->
593 						    PhysDiskDevHandle);
594 					}
595 				break;
596 				case MPI2_RAID_PD_STATE_OFFLINE:
597 				case MPI2_RAID_PD_STATE_NOT_CONFIGURED:
598 				case MPI2_RAID_PD_STATE_NOT_COMPATIBLE:
599 				default:
600 					targ = mprsas_find_target_by_handle(
601 					    sassc, 0,
602 					    event_data->PhysDiskDevHandle);
603 					if (targ) {
604 						targ->flags |=
605 					    ~MPR_TARGET_FLAGS_RAID_COMPONENT;
606 						printf("%s %d: Found Target "
607 						    "for handle 0x%x.  \n",
608 						    __func__, __LINE__ ,
609 						    event_data->
610 						    PhysDiskDevHandle);
611 					}
612 				break;
613 			}
614 		default:
615 			break;
616 		}
617 		break;
618 	}
619 	case MPI2_EVENT_IR_OPERATION_STATUS:
620 	{
621 		Mpi2EventDataIrOperationStatus_t *event_data =
622 		    fw_event->event_data;
623 
624 		/*
625 		 * Informational only.
626 		 */
627 		mpr_dprint(sc, MPR_EVENT, "Received IR Op Status event:\n");
628 		mpr_dprint(sc, MPR_EVENT, "   RAID Operation of %d is %d "
629 		    "percent complete for Volume with handle 0x%x",
630 		    event_data->RAIDOperation, event_data->PercentComplete,
631 		    le16toh(event_data->VolDevHandle));
632 		break;
633 	}
634 	case MPI2_EVENT_TEMP_THRESHOLD:
635 	{
636 		pMpi2EventDataTemperature_t	temp_event;
637 
638 		temp_event = (pMpi2EventDataTemperature_t)fw_event->event_data;
639 
640 		/*
641 		 * The Temp Sensor Count must be greater than the event's Sensor
642 		 * Num to be valid.  If valid, print the temp thresholds that
643 		 * have been exceeded.
644 		 */
645 		if (sc->iounit_pg8.NumSensors > temp_event->SensorNum) {
646 			mpr_dprint(sc, MPR_FAULT, "Temperature Threshold flags "
647 			    "%s %s %s %s exceeded for Sensor: %d !!!\n",
648 			    ((temp_event->Status & 0x01) == 1) ? "0 " : " ",
649 			    ((temp_event->Status & 0x02) == 2) ? "1 " : " ",
650 			    ((temp_event->Status & 0x04) == 4) ? "2 " : " ",
651 			    ((temp_event->Status & 0x08) == 8) ? "3 " : " ",
652 			    temp_event->SensorNum);
653 			mpr_dprint(sc, MPR_FAULT, "Current Temp in Celsius: "
654 			    "%d\n", temp_event->CurrentTemperature);
655 		}
656 		break;
657 	}
658 	case MPI2_EVENT_ACTIVE_CABLE_EXCEPTION:
659 	{
660 		pMpi26EventDataActiveCableExcept_t	ace_event_data;
661 		ace_event_data =
662 		    (pMpi26EventDataActiveCableExcept_t)fw_event->event_data;
663 
664 		switch(ace_event_data->ReasonCode) {
665 		case MPI26_EVENT_ACTIVE_CABLE_INSUFFICIENT_POWER:
666 		{
667 			mpr_printf(sc, "Currently a cable with "
668 			    "ReceptacleID %d cannot be powered and device "
669 			    "connected to this active cable will not be seen. "
670 			    "This active cable requires %d mW of power.\n",
671 			    ace_event_data->ReceptacleID,
672 			    ace_event_data->ActiveCablePowerRequirement);
673 			break;
674 		}
675 		case MPI26_EVENT_ACTIVE_CABLE_DEGRADED:
676 		{
677 			mpr_printf(sc, "Currently a cable with "
678 			    "ReceptacleID %d is not running at optimal speed "
679 			    "(12 Gb/s rate)\n", ace_event_data->ReceptacleID);
680 			break;
681 		}
682 		default:
683 			break;
684 		}
685 		break;
686 	}
687 	case MPI2_EVENT_PCIE_DEVICE_STATUS_CHANGE:
688 	{
689 		pMpi26EventDataPCIeDeviceStatusChange_t	pcie_status_event_data;
690 		pcie_status_event_data =
691 		   (pMpi26EventDataPCIeDeviceStatusChange_t)fw_event->event_data;
692 
693 		switch (pcie_status_event_data->ReasonCode) {
694 		case MPI26_EVENT_PCIDEV_STAT_RC_PCIE_HOT_RESET_FAILED:
695 		{
696 			mpr_printf(sc, "PCIe Host Reset failed on DevHandle "
697 			    "0x%x\n", pcie_status_event_data->DevHandle);
698 			break;
699 		}
700 		default:
701 			break;
702 		}
703 		break;
704 	}
705 	case MPI2_EVENT_SAS_DEVICE_DISCOVERY_ERROR:
706 	{
707 		pMpi25EventDataSasDeviceDiscoveryError_t discovery_error_data;
708 		uint64_t sas_address;
709 
710 		discovery_error_data =
711 		    (pMpi25EventDataSasDeviceDiscoveryError_t)
712 		    fw_event->event_data;
713 
714 		sas_address = discovery_error_data->SASAddress.High;
715 		sas_address = (sas_address << 32) |
716 		    discovery_error_data->SASAddress.Low;
717 
718 		switch(discovery_error_data->ReasonCode) {
719 		case MPI25_EVENT_SAS_DISC_ERR_SMP_FAILED:
720 		{
721 			mpr_printf(sc, "SMP command failed during discovery "
722 			    "for expander with SAS Address %jx and "
723 			    "handle 0x%x.\n", sas_address,
724 			    discovery_error_data->DevHandle);
725 			break;
726 		}
727 		case MPI25_EVENT_SAS_DISC_ERR_SMP_TIMEOUT:
728 		{
729 			mpr_printf(sc, "SMP command timed out during "
730 			    "discovery for expander with SAS Address %jx and "
731 			    "handle 0x%x.\n", sas_address,
732 			    discovery_error_data->DevHandle);
733 			break;
734 		}
735 		default:
736 			break;
737 		}
738 		break;
739 	}
740 	case MPI2_EVENT_PCIE_TOPOLOGY_CHANGE_LIST:
741 	{
742 		MPI26_EVENT_DATA_PCIE_TOPOLOGY_CHANGE_LIST *data;
743 		MPI26_EVENT_PCIE_TOPO_PORT_ENTRY *port_entry;
744 		uint8_t i, link_rate;
745 		uint16_t handle;
746 
747 		data = (MPI26_EVENT_DATA_PCIE_TOPOLOGY_CHANGE_LIST *)
748 		    fw_event->event_data;
749 
750 		mpr_mapping_pcie_topology_change_event(sc,
751 		    fw_event->event_data);
752 
753 		for (i = 0; i < data->NumEntries; i++) {
754 			port_entry = &data->PortEntry[i];
755 			handle = le16toh(port_entry->AttachedDevHandle);
756 			link_rate = port_entry->CurrentPortInfo &
757 			    MPI26_EVENT_PCIE_TOPO_PI_RATE_MASK;
758 			switch (port_entry->PortStatus) {
759 			case MPI26_EVENT_PCIE_TOPO_PS_DEV_ADDED:
760 				if (link_rate <
761 				    MPI26_EVENT_PCIE_TOPO_PI_RATE_2_5) {
762 					mpr_dprint(sc, MPR_ERROR, "%s: Cannot "
763 					    "add PCIe device with handle 0x%x "
764 					    "with unknown link rate.\n",
765 					    __func__, handle);
766 					break;
767 				}
768 				if (mprsas_add_pcie_device(sc, handle,
769 				    link_rate)) {
770 					mpr_dprint(sc, MPR_ERROR, "%s: failed "
771 					    "to add PCIe device with handle "
772 					    "0x%x\n", __func__, handle);
773 					mprsas_prepare_remove(sassc, handle);
774 				}
775 				break;
776 			case MPI26_EVENT_PCIE_TOPO_PS_NOT_RESPONDING:
777 				mprsas_prepare_remove(sassc, handle);
778 				break;
779 			case MPI26_EVENT_PCIE_TOPO_PS_PORT_CHANGED:
780 			case MPI26_EVENT_PCIE_TOPO_PS_NO_CHANGE:
781 			case MPI26_EVENT_PCIE_TOPO_PS_DELAY_NOT_RESPONDING:
782 			default:
783 				break;
784 			}
785 		}
786 		/*
787 		 * refcount was incremented for this event in
788 		 * mprsas_evt_handler.  Decrement it here because the event has
789 		 * been processed.
790 		 */
791 		mprsas_startup_decrement(sassc);
792 		break;
793 	}
794 	case MPI2_EVENT_SAS_DEVICE_STATUS_CHANGE:
795 	case MPI2_EVENT_SAS_BROADCAST_PRIMITIVE:
796 	default:
797 		mpr_dprint(sc, MPR_TRACE,"Unhandled event 0x%0X\n",
798 		    fw_event->event);
799 		break;
800 	}
801 	mpr_dprint(sc, MPR_EVENT, "(%d)->(%s) Event Free: [%x]\n", event_count,
802 	    __func__, fw_event->event);
803 	mprsas_fw_event_free(sc, fw_event);
804 }
805 
806 void
807 mprsas_firmware_event_work(void *arg, int pending)
808 {
809 	struct mpr_fw_event_work *fw_event;
810 	struct mpr_softc *sc;
811 
812 	sc = (struct mpr_softc *)arg;
813 	mpr_lock(sc);
814 	while ((fw_event = TAILQ_FIRST(&sc->sassc->ev_queue)) != NULL) {
815 		TAILQ_REMOVE(&sc->sassc->ev_queue, fw_event, ev_link);
816 		mprsas_fw_work(sc, fw_event);
817 	}
818 	mpr_unlock(sc);
819 }
820 
821 static int
822 mprsas_add_device(struct mpr_softc *sc, u16 handle, u8 linkrate)
823 {
824 	char devstring[80];
825 	struct mprsas_softc *sassc;
826 	struct mprsas_target *targ;
827 	Mpi2ConfigReply_t mpi_reply;
828 	Mpi2SasDevicePage0_t config_page;
829 	uint64_t sas_address, parent_sas_address = 0;
830 	u32 device_info, parent_devinfo = 0;
831 	unsigned int id;
832 	int ret = 1, error = 0, i;
833 	struct mprsas_lun *lun;
834 	u8 is_SATA_SSD = 0;
835 	struct mpr_command *cm;
836 
837 	sassc = sc->sassc;
838 	mprsas_startup_increment(sassc);
839 	if (mpr_config_get_sas_device_pg0(sc, &mpi_reply, &config_page,
840 	    MPI2_SAS_DEVICE_PGAD_FORM_HANDLE, handle) != 0) {
841 		mpr_dprint(sc, MPR_INFO|MPR_MAPPING|MPR_FAULT,
842 		    "Error reading SAS device %#x page0, iocstatus= 0x%x\n",
843 		    handle, mpi_reply.IOCStatus);
844 		error = ENXIO;
845 		goto out;
846 	}
847 
848 	device_info = le32toh(config_page.DeviceInfo);
849 
850 	if (((device_info & MPI2_SAS_DEVICE_INFO_SMP_TARGET) == 0)
851 	    && (le16toh(config_page.ParentDevHandle) != 0)) {
852 		Mpi2ConfigReply_t tmp_mpi_reply;
853 		Mpi2SasDevicePage0_t parent_config_page;
854 
855 		if (mpr_config_get_sas_device_pg0(sc, &tmp_mpi_reply,
856 		    &parent_config_page, MPI2_SAS_DEVICE_PGAD_FORM_HANDLE,
857 		    le16toh(config_page.ParentDevHandle)) != 0) {
858 			mpr_dprint(sc, MPR_MAPPING|MPR_FAULT,
859 			    "Error reading parent SAS device %#x page0, "
860 			    "iocstatus= 0x%x\n",
861 			    le16toh(config_page.ParentDevHandle),
862 			    tmp_mpi_reply.IOCStatus);
863 		} else {
864 			parent_sas_address = parent_config_page.SASAddress.High;
865 			parent_sas_address = (parent_sas_address << 32) |
866 			    parent_config_page.SASAddress.Low;
867 			parent_devinfo = le32toh(parent_config_page.DeviceInfo);
868 		}
869 	}
870 	/* TODO Check proper endianness */
871 	sas_address = config_page.SASAddress.High;
872 	sas_address = (sas_address << 32) | config_page.SASAddress.Low;
873 	mpr_dprint(sc, MPR_MAPPING, "Handle 0x%04x SAS Address from SAS device "
874 	    "page0 = %jx\n", handle, sas_address);
875 
876 	/*
877 	 * Always get SATA Identify information because this is used to
878 	 * determine if Start/Stop Unit should be sent to the drive when the
879 	 * system is shutdown.
880 	 */
881 	if (device_info & MPI2_SAS_DEVICE_INFO_SATA_DEVICE) {
882 		ret = mprsas_get_sas_address_for_sata_disk(sc, &sas_address,
883 		    handle, device_info, &is_SATA_SSD);
884 		if (ret) {
885 			mpr_dprint(sc, MPR_MAPPING|MPR_ERROR,
886 			    "%s: failed to get disk type (SSD or HDD) for SATA "
887 			    "device with handle 0x%04x\n",
888 			    __func__, handle);
889 		} else {
890 			mpr_dprint(sc, MPR_MAPPING, "Handle 0x%04x SAS Address "
891 			    "from SATA device = %jx\n", handle, sas_address);
892 		}
893 	}
894 
895 	/*
896 	 * use_phynum:
897 	 *  1 - use the PhyNum field as a fallback to the mapping logic
898 	 *  0 - never use the PhyNum field
899 	 * -1 - only use the PhyNum field
900 	 *
901 	 * Note that using the Phy number to map a device can cause device adds
902 	 * to fail if multiple enclosures/expanders are in the topology. For
903 	 * example, if two devices are in the same slot number in two different
904 	 * enclosures within the topology, only one of those devices will be
905 	 * added. PhyNum mapping should not be used if multiple enclosures are
906 	 * in the topology.
907 	 */
908 	id = MPR_MAP_BAD_ID;
909 	if (sc->use_phynum != -1)
910 		id = mpr_mapping_get_tid(sc, sas_address, handle);
911 	if (id == MPR_MAP_BAD_ID) {
912 		if ((sc->use_phynum == 0) ||
913 		    ((id = config_page.PhyNum) > sassc->maxtargets)) {
914 			mpr_dprint(sc, MPR_INFO, "failure at %s:%d/%s()! "
915 			    "Could not get ID for device with handle 0x%04x\n",
916 			    __FILE__, __LINE__, __func__, handle);
917 			error = ENXIO;
918 			goto out;
919 		}
920 	}
921 	mpr_dprint(sc, MPR_MAPPING, "%s: Target ID for added device is %d.\n",
922 	    __func__, id);
923 
924 	/*
925 	 * Only do the ID check and reuse check if the target is not from a
926 	 * RAID Component. For Physical Disks of a Volume, the ID will be reused
927 	 * when a volume is deleted because the mapping entry for the PD will
928 	 * still be in the mapping table. The ID check should not be done here
929 	 * either since this PD is already being used.
930 	 */
931 	targ = &sassc->targets[id];
932 	if (!(targ->flags & MPR_TARGET_FLAGS_RAID_COMPONENT)) {
933 		if (mprsas_check_id(sassc, id) != 0) {
934 			mpr_dprint(sc, MPR_MAPPING|MPR_INFO,
935 			    "Excluding target id %d\n", id);
936 			error = ENXIO;
937 			goto out;
938 		}
939 
940 		if (targ->handle != 0x0) {
941 			mpr_dprint(sc, MPR_MAPPING, "Attempting to reuse "
942 			    "target id %d handle 0x%04x\n", id, targ->handle);
943 			error = ENXIO;
944 			goto out;
945 		}
946 	}
947 
948 	targ->devinfo = device_info;
949 	targ->devname = le32toh(config_page.DeviceName.High);
950 	targ->devname = (targ->devname << 32) |
951 	    le32toh(config_page.DeviceName.Low);
952 	targ->encl_handle = le16toh(config_page.EnclosureHandle);
953 	targ->encl_slot = le16toh(config_page.Slot);
954 	targ->encl_level = config_page.EnclosureLevel;
955 	targ->connector_name[0] = config_page.ConnectorName[0];
956 	targ->connector_name[1] = config_page.ConnectorName[1];
957 	targ->connector_name[2] = config_page.ConnectorName[2];
958 	targ->connector_name[3] = config_page.ConnectorName[3];
959 	targ->handle = handle;
960 	targ->parent_handle = le16toh(config_page.ParentDevHandle);
961 	targ->sasaddr = mpr_to_u64(&config_page.SASAddress);
962 	targ->parent_sasaddr = le64toh(parent_sas_address);
963 	targ->parent_devinfo = parent_devinfo;
964 	targ->tid = id;
965 	targ->linkrate = (linkrate>>4);
966 	targ->flags = 0;
967 	if (is_SATA_SSD) {
968 		targ->flags = MPR_TARGET_IS_SATA_SSD;
969 	}
970 	if ((le16toh(config_page.Flags) &
971 	    MPI25_SAS_DEVICE0_FLAGS_ENABLED_FAST_PATH) &&
972 	    (le16toh(config_page.Flags) &
973 	    MPI25_SAS_DEVICE0_FLAGS_FAST_PATH_CAPABLE)) {
974 		targ->scsi_req_desc_type =
975 		    MPI25_REQ_DESCRIPT_FLAGS_FAST_PATH_SCSI_IO;
976 	}
977 	if (le16toh(config_page.Flags) &
978 	    MPI2_SAS_DEVICE0_FLAGS_ENCL_LEVEL_VALID) {
979 		targ->encl_level_valid = TRUE;
980 	}
981 	TAILQ_INIT(&targ->commands);
982 	TAILQ_INIT(&targ->timedout_commands);
983 	while (!SLIST_EMPTY(&targ->luns)) {
984 		lun = SLIST_FIRST(&targ->luns);
985 		SLIST_REMOVE_HEAD(&targ->luns, lun_link);
986 		free(lun, M_MPR);
987 	}
988 	SLIST_INIT(&targ->luns);
989 
990 	mpr_describe_devinfo(targ->devinfo, devstring, 80);
991 	mpr_dprint(sc, (MPR_INFO|MPR_MAPPING), "Found device <%s> <%s> "
992 	    "handle<0x%04x> enclosureHandle<0x%04x> slot %d\n", devstring,
993 	    mpr_describe_table(mpr_linkrate_names, targ->linkrate),
994 	    targ->handle, targ->encl_handle, targ->encl_slot);
995 	if (targ->encl_level_valid) {
996 		mpr_dprint(sc, (MPR_INFO|MPR_MAPPING), "At enclosure level %d "
997 		    "and connector name (%4s)\n", targ->encl_level,
998 		    targ->connector_name);
999 	}
1000 	mprsas_rescan_target(sc, targ);
1001 	mpr_dprint(sc, MPR_MAPPING, "Target id 0x%x added\n", targ->tid);
1002 
1003 	/*
1004 	 * Check all commands to see if the SATA_ID_TIMEOUT flag has been set.
1005 	 * If so, send a Target Reset TM to the target that was just created.
1006 	 * An Abort Task TM should be used instead of a Target Reset, but that
1007 	 * would be much more difficult because targets have not been fully
1008 	 * discovered yet, and LUN's haven't been setup.  So, just reset the
1009 	 * target instead of the LUN.
1010 	 */
1011 	for (i = 1; i < sc->num_reqs; i++) {
1012 		cm = &sc->commands[i];
1013 		if (cm->cm_flags & MPR_CM_FLAGS_SATA_ID_TIMEOUT) {
1014 			targ->timeouts++;
1015 			cm->cm_flags |= MPR_CM_FLAGS_TIMEDOUT;
1016 
1017 			if ((targ->tm = mprsas_alloc_tm(sc)) != NULL) {
1018 				mpr_dprint(sc, MPR_INFO, "%s: sending Target "
1019 				    "Reset for stuck SATA identify command "
1020 				    "(cm = %p)\n", __func__, cm);
1021 				targ->tm->cm_targ = targ;
1022 				mprsas_send_reset(sc, targ->tm,
1023 				    MPI2_SCSITASKMGMT_TASKTYPE_TARGET_RESET);
1024 			} else {
1025 				mpr_dprint(sc, MPR_ERROR, "Failed to allocate "
1026 				    "tm for Target Reset after SATA ID command "
1027 				    "timed out (cm %p)\n", cm);
1028 			}
1029 			/*
1030 			 * No need to check for more since the target is
1031 			 * already being reset.
1032 			 */
1033 			break;
1034 		}
1035 	}
1036 out:
1037 	/*
1038 	 * Free the commands that may not have been freed from the SATA ID call
1039 	 */
1040 	for (i = 1; i < sc->num_reqs; i++) {
1041 		cm = &sc->commands[i];
1042 		if (cm->cm_flags & MPR_CM_FLAGS_SATA_ID_TIMEOUT) {
1043 			free(cm->cm_data, M_MPR);
1044 			mpr_free_command(sc, cm);
1045 		}
1046 	}
1047 	mprsas_startup_decrement(sassc);
1048 	return (error);
1049 }
1050 
1051 int
1052 mprsas_get_sas_address_for_sata_disk(struct mpr_softc *sc,
1053     u64 *sas_address, u16 handle, u32 device_info, u8 *is_SATA_SSD)
1054 {
1055 	Mpi2SataPassthroughReply_t mpi_reply;
1056 	int i, rc, try_count;
1057 	u32 *bufferptr;
1058 	union _sata_sas_address hash_address;
1059 	struct _ata_identify_device_data ata_identify;
1060 	u8 buffer[MPT2SAS_MN_LEN + MPT2SAS_SN_LEN];
1061 	u32 ioc_status;
1062 	u8 sas_status;
1063 
1064 	memset(&ata_identify, 0, sizeof(ata_identify));
1065 	memset(&mpi_reply, 0, sizeof(mpi_reply));
1066 	try_count = 0;
1067 	do {
1068 		rc = mprsas_get_sata_identify(sc, handle, &mpi_reply,
1069 		    (char *)&ata_identify, sizeof(ata_identify), device_info);
1070 		try_count++;
1071 		ioc_status = le16toh(mpi_reply.IOCStatus)
1072 		    & MPI2_IOCSTATUS_MASK;
1073 		sas_status = mpi_reply.SASStatus;
1074 		switch (ioc_status) {
1075 		case MPI2_IOCSTATUS_SUCCESS:
1076 			break;
1077 		case MPI2_IOCSTATUS_SCSI_PROTOCOL_ERROR:
1078 			/* No sense sleeping.  this error won't get better */
1079 			break;
1080 		default:
1081 			if (sc->spinup_wait_time > 0) {
1082 				mpr_dprint(sc, MPR_INFO, "Sleeping %d seconds "
1083 				    "after SATA ID error to wait for spinup\n",
1084 				    sc->spinup_wait_time);
1085 				msleep(&sc->msleep_fake_chan, &sc->mpr_mtx, 0,
1086 				    "mprid", sc->spinup_wait_time * hz);
1087 			}
1088 		}
1089 	} while (((rc && (rc != EWOULDBLOCK)) ||
1090 	    (ioc_status && (ioc_status != MPI2_IOCSTATUS_SCSI_PROTOCOL_ERROR))
1091 	    || sas_status) && (try_count < 5));
1092 
1093 	if (rc == 0 && !ioc_status && !sas_status) {
1094 		mpr_dprint(sc, MPR_MAPPING, "%s: got SATA identify "
1095 		    "successfully for handle = 0x%x with try_count = %d\n",
1096 		    __func__, handle, try_count);
1097 	} else {
1098 		mpr_dprint(sc, MPR_MAPPING, "%s: handle = 0x%x failed\n",
1099 		    __func__, handle);
1100 		return -1;
1101 	}
1102 	/* Copy & byteswap the 40 byte model number to a buffer */
1103 	for (i = 0; i < MPT2SAS_MN_LEN; i += 2) {
1104 		buffer[i] = ((u8 *)ata_identify.model_number)[i + 1];
1105 		buffer[i + 1] = ((u8 *)ata_identify.model_number)[i];
1106 	}
1107 	/* Copy & byteswap the 20 byte serial number to a buffer */
1108 	for (i = 0; i < MPT2SAS_SN_LEN; i += 2) {
1109 		buffer[MPT2SAS_MN_LEN + i] =
1110 		    ((u8 *)ata_identify.serial_number)[i + 1];
1111 		buffer[MPT2SAS_MN_LEN + i + 1] =
1112 		    ((u8 *)ata_identify.serial_number)[i];
1113 	}
1114 	bufferptr = (u32 *)buffer;
1115 	/* There are 60 bytes to hash down to 8. 60 isn't divisible by 8,
1116 	 * so loop through the first 56 bytes (7*8),
1117 	 * and then add in the last dword.
1118 	 */
1119 	hash_address.word.low  = 0;
1120 	hash_address.word.high = 0;
1121 	for (i = 0; (i < ((MPT2SAS_MN_LEN+MPT2SAS_SN_LEN)/8)); i++) {
1122 		hash_address.word.low += *bufferptr;
1123 		bufferptr++;
1124 		hash_address.word.high += *bufferptr;
1125 		bufferptr++;
1126 	}
1127 	/* Add the last dword */
1128 	hash_address.word.low += *bufferptr;
1129 	/* Make sure the hash doesn't start with 5, because it could clash
1130 	 * with a SAS address. Change 5 to a D.
1131 	 */
1132 	if ((hash_address.word.high & 0x000000F0) == (0x00000050))
1133 		hash_address.word.high |= 0x00000080;
1134 	*sas_address = (u64)hash_address.wwid[0] << 56 |
1135 	    (u64)hash_address.wwid[1] << 48 | (u64)hash_address.wwid[2] << 40 |
1136 	    (u64)hash_address.wwid[3] << 32 | (u64)hash_address.wwid[4] << 24 |
1137 	    (u64)hash_address.wwid[5] << 16 | (u64)hash_address.wwid[6] <<  8 |
1138 	    (u64)hash_address.wwid[7];
1139 	if (ata_identify.rotational_speed == 1) {
1140 		*is_SATA_SSD = 1;
1141 	}
1142 
1143 	return 0;
1144 }
1145 
1146 static int
1147 mprsas_get_sata_identify(struct mpr_softc *sc, u16 handle,
1148     Mpi2SataPassthroughReply_t *mpi_reply, char *id_buffer, int sz, u32 devinfo)
1149 {
1150 	Mpi2SataPassthroughRequest_t *mpi_request;
1151 	Mpi2SataPassthroughReply_t *reply;
1152 	struct mpr_command *cm;
1153 	char *buffer;
1154 	int error = 0;
1155 
1156 	buffer = malloc( sz, M_MPR, M_NOWAIT | M_ZERO);
1157 	if (!buffer)
1158 		return ENOMEM;
1159 
1160 	if ((cm = mpr_alloc_command(sc)) == NULL) {
1161 		free(buffer, M_MPR);
1162 		return (EBUSY);
1163 	}
1164 	mpi_request = (MPI2_SATA_PASSTHROUGH_REQUEST *)cm->cm_req;
1165 	bzero(mpi_request,sizeof(MPI2_SATA_PASSTHROUGH_REQUEST));
1166 	mpi_request->Function = MPI2_FUNCTION_SATA_PASSTHROUGH;
1167 	mpi_request->VF_ID = 0;
1168 	mpi_request->DevHandle = htole16(handle);
1169 	mpi_request->PassthroughFlags = (MPI2_SATA_PT_REQ_PT_FLAGS_PIO |
1170 	    MPI2_SATA_PT_REQ_PT_FLAGS_READ);
1171 	mpi_request->DataLength = htole32(sz);
1172 	mpi_request->CommandFIS[0] = 0x27;
1173 	mpi_request->CommandFIS[1] = 0x80;
1174 	mpi_request->CommandFIS[2] =  (devinfo &
1175 	    MPI2_SAS_DEVICE_INFO_ATAPI_DEVICE) ? 0xA1 : 0xEC;
1176 	cm->cm_sge = &mpi_request->SGL;
1177 	cm->cm_sglsize = sizeof(MPI2_SGE_IO_UNION);
1178 	cm->cm_flags = MPR_CM_FLAGS_DATAIN;
1179 	cm->cm_desc.Default.RequestFlags = MPI2_REQ_DESCRIPT_FLAGS_DEFAULT_TYPE;
1180 	cm->cm_data = buffer;
1181 	cm->cm_length = htole32(sz);
1182 
1183 	/*
1184 	 * Use a custom handler to avoid reinit'ing the controller on timeout.
1185 	 * This fixes a problem where the FW does not send a reply sometimes
1186 	 * when a bad disk is in the topology. So, this is used to timeout the
1187 	 * command so that processing can continue normally.
1188 	 */
1189 	cm->cm_timeout_handler = mprsas_ata_id_timeout;
1190 
1191 	error = mpr_wait_command(sc, &cm, MPR_ATA_ID_TIMEOUT, CAN_SLEEP);
1192 
1193 	/* mprsas_ata_id_timeout does not reset controller */
1194 	KASSERT(cm != NULL, ("%s: surprise command freed", __func__));
1195 
1196 	reply = (Mpi2SataPassthroughReply_t *)cm->cm_reply;
1197 	if (error || (reply == NULL)) {
1198 		/* FIXME */
1199 		/*
1200 		 * If the request returns an error then we need to do a diag
1201 		 * reset
1202 		 */
1203 		mpr_dprint(sc, MPR_INFO|MPR_FAULT|MPR_MAPPING,
1204 		    "Request for SATA PASSTHROUGH page completed with error %d\n",
1205 		    error);
1206 		error = ENXIO;
1207 		goto out;
1208 	}
1209 	bcopy(buffer, id_buffer, sz);
1210 	bcopy(reply, mpi_reply, sizeof(Mpi2SataPassthroughReply_t));
1211 	if ((le16toh(reply->IOCStatus) & MPI2_IOCSTATUS_MASK) !=
1212 	    MPI2_IOCSTATUS_SUCCESS) {
1213 		mpr_dprint(sc, MPR_INFO|MPR_MAPPING|MPR_FAULT,
1214 		    "Error reading device %#x SATA PASSTHRU; iocstatus= 0x%x\n",
1215 		    handle, reply->IOCStatus);
1216 		error = ENXIO;
1217 		goto out;
1218 	}
1219 out:
1220 	/*
1221 	 * If the SATA_ID_TIMEOUT flag has been set for this command, don't free
1222 	 * it.  The command and buffer will be freed after sending an Abort
1223 	 * Task TM.
1224 	 */
1225 	if ((cm->cm_flags & MPR_CM_FLAGS_SATA_ID_TIMEOUT) == 0) {
1226 		mpr_free_command(sc, cm);
1227 		free(buffer, M_MPR);
1228 	}
1229 	return (error);
1230 }
1231 
1232 static void
1233 mprsas_ata_id_timeout(struct mpr_softc *sc, struct mpr_command *cm)
1234 {
1235 
1236 	mpr_dprint(sc, MPR_INFO, "%s ATA ID command timeout cm %p sc %p\n",
1237 	    __func__, cm, sc);
1238 
1239 	/*
1240 	 * The Abort Task cannot be sent from here because the driver has not
1241 	 * completed setting up targets.  Instead, the command is flagged so
1242 	 * that special handling will be used to send the abort. Now that
1243 	 * this command has timed out, it's no longer in the queue.
1244 	 */
1245 	cm->cm_flags |= MPR_CM_FLAGS_SATA_ID_TIMEOUT;
1246 	cm->cm_state = MPR_CM_STATE_BUSY;
1247 }
1248 
1249 static int
1250 mprsas_add_pcie_device(struct mpr_softc *sc, u16 handle, u8 linkrate)
1251 {
1252 	char devstring[80];
1253 	struct mprsas_softc *sassc;
1254 	struct mprsas_target *targ;
1255 	Mpi2ConfigReply_t mpi_reply;
1256 	Mpi26PCIeDevicePage0_t config_page;
1257 	Mpi26PCIeDevicePage2_t config_page2;
1258 	uint64_t pcie_wwid, parent_wwid = 0;
1259 	u32 device_info, parent_devinfo = 0;
1260 	unsigned int id;
1261 	int error = 0;
1262 	struct mprsas_lun *lun;
1263 
1264 	sassc = sc->sassc;
1265 	mprsas_startup_increment(sassc);
1266 	if ((mpr_config_get_pcie_device_pg0(sc, &mpi_reply, &config_page,
1267 	     MPI26_PCIE_DEVICE_PGAD_FORM_HANDLE, handle))) {
1268 		printf("%s: error reading PCIe device page0\n", __func__);
1269 		error = ENXIO;
1270 		goto out;
1271 	}
1272 
1273 	device_info = le32toh(config_page.DeviceInfo);
1274 
1275 	if (((device_info & MPI26_PCIE_DEVINFO_PCI_SWITCH) == 0)
1276 	    && (le16toh(config_page.ParentDevHandle) != 0)) {
1277 		Mpi2ConfigReply_t tmp_mpi_reply;
1278 		Mpi26PCIeDevicePage0_t parent_config_page;
1279 
1280 		if ((mpr_config_get_pcie_device_pg0(sc, &tmp_mpi_reply,
1281 		     &parent_config_page, MPI26_PCIE_DEVICE_PGAD_FORM_HANDLE,
1282 		     le16toh(config_page.ParentDevHandle)))) {
1283 			printf("%s: error reading PCIe device %#x page0\n",
1284 			    __func__, le16toh(config_page.ParentDevHandle));
1285 		} else {
1286 			parent_wwid = parent_config_page.WWID.High;
1287 			parent_wwid = (parent_wwid << 32) |
1288 			    parent_config_page.WWID.Low;
1289 			parent_devinfo = le32toh(parent_config_page.DeviceInfo);
1290 		}
1291 	}
1292 	/* TODO Check proper endianness */
1293 	pcie_wwid = config_page.WWID.High;
1294 	pcie_wwid = (pcie_wwid << 32) | config_page.WWID.Low;
1295 	mpr_dprint(sc, MPR_INFO, "PCIe WWID from PCIe device page0 = %jx\n",
1296 	    pcie_wwid);
1297 
1298 	if ((mpr_config_get_pcie_device_pg2(sc, &mpi_reply, &config_page2,
1299 	     MPI26_PCIE_DEVICE_PGAD_FORM_HANDLE, handle))) {
1300 		printf("%s: error reading PCIe device page2\n", __func__);
1301 		error = ENXIO;
1302 		goto out;
1303 	}
1304 
1305 	id = mpr_mapping_get_tid(sc, pcie_wwid, handle);
1306 	if (id == MPR_MAP_BAD_ID) {
1307 		mpr_dprint(sc, MPR_ERROR | MPR_INFO, "failure at %s:%d/%s()! "
1308 		    "Could not get ID for device with handle 0x%04x\n",
1309 		    __FILE__, __LINE__, __func__, handle);
1310 		error = ENXIO;
1311 		goto out;
1312 	}
1313 	mpr_dprint(sc, MPR_MAPPING, "%s: Target ID for added device is %d.\n",
1314 	    __func__, id);
1315 
1316 	if (mprsas_check_id(sassc, id) != 0) {
1317 		mpr_dprint(sc, MPR_MAPPING|MPR_INFO,
1318 		    "Excluding target id %d\n", id);
1319 		error = ENXIO;
1320 		goto out;
1321 	}
1322 
1323 	mpr_dprint(sc, MPR_MAPPING, "WWID from PCIe device page0 = %jx\n",
1324 	    pcie_wwid);
1325 	targ = &sassc->targets[id];
1326 	targ->devinfo = device_info;
1327 	targ->encl_handle = le16toh(config_page.EnclosureHandle);
1328 	targ->encl_slot = le16toh(config_page.Slot);
1329 	targ->encl_level = config_page.EnclosureLevel;
1330 	targ->connector_name[0] = ((char *)&config_page.ConnectorName)[0];
1331 	targ->connector_name[1] = ((char *)&config_page.ConnectorName)[1];
1332 	targ->connector_name[2] = ((char *)&config_page.ConnectorName)[2];
1333 	targ->connector_name[3] = ((char *)&config_page.ConnectorName)[3];
1334 	targ->is_nvme = device_info & MPI26_PCIE_DEVINFO_NVME;
1335 	targ->MDTS = config_page2.MaximumDataTransferSize;
1336 	if (targ->is_nvme)
1337 		targ->controller_reset_timeout = config_page2.ControllerResetTO;
1338 	/*
1339 	 * Assume always TRUE for encl_level_valid because there is no valid
1340 	 * flag for PCIe.
1341 	 */
1342 	targ->encl_level_valid = TRUE;
1343 	targ->handle = handle;
1344 	targ->parent_handle = le16toh(config_page.ParentDevHandle);
1345 	targ->sasaddr = mpr_to_u64(&config_page.WWID);
1346 	targ->parent_sasaddr = le64toh(parent_wwid);
1347 	targ->parent_devinfo = parent_devinfo;
1348 	targ->tid = id;
1349 	targ->linkrate = linkrate;
1350 	targ->flags = 0;
1351 	if ((le16toh(config_page.Flags) &
1352 	    MPI26_PCIEDEV0_FLAGS_ENABLED_FAST_PATH) &&
1353 	    (le16toh(config_page.Flags) &
1354 	    MPI26_PCIEDEV0_FLAGS_FAST_PATH_CAPABLE)) {
1355 		targ->scsi_req_desc_type =
1356 		    MPI25_REQ_DESCRIPT_FLAGS_FAST_PATH_SCSI_IO;
1357 	}
1358 	TAILQ_INIT(&targ->commands);
1359 	TAILQ_INIT(&targ->timedout_commands);
1360 	while (!SLIST_EMPTY(&targ->luns)) {
1361 		lun = SLIST_FIRST(&targ->luns);
1362 		SLIST_REMOVE_HEAD(&targ->luns, lun_link);
1363 		free(lun, M_MPR);
1364 	}
1365 	SLIST_INIT(&targ->luns);
1366 
1367 	mpr_describe_devinfo(targ->devinfo, devstring, 80);
1368 	mpr_dprint(sc, (MPR_INFO|MPR_MAPPING), "Found PCIe device <%s> <%s> "
1369 	    "handle<0x%04x> enclosureHandle<0x%04x> slot %d\n", devstring,
1370 	    mpr_describe_table(mpr_pcie_linkrate_names, targ->linkrate),
1371 	    targ->handle, targ->encl_handle, targ->encl_slot);
1372 	if (targ->encl_level_valid) {
1373 		mpr_dprint(sc, (MPR_INFO|MPR_MAPPING), "At enclosure level %d "
1374 		    "and connector name (%4s)\n", targ->encl_level,
1375 		    targ->connector_name);
1376 	}
1377 	mprsas_rescan_target(sc, targ);
1378 	mpr_dprint(sc, MPR_MAPPING, "Target id 0x%x added\n", targ->tid);
1379 
1380 out:
1381 	mprsas_startup_decrement(sassc);
1382 	return (error);
1383 }
1384 
1385 static int
1386 mprsas_volume_add(struct mpr_softc *sc, u16 handle)
1387 {
1388 	struct mprsas_softc *sassc;
1389 	struct mprsas_target *targ;
1390 	u64 wwid;
1391 	unsigned int id;
1392 	int error = 0;
1393 	struct mprsas_lun *lun;
1394 
1395 	sassc = sc->sassc;
1396 	mprsas_startup_increment(sassc);
1397 	/* wwid is endian safe */
1398 	mpr_config_get_volume_wwid(sc, handle, &wwid);
1399 	if (!wwid) {
1400 		printf("%s: invalid WWID; cannot add volume to mapping table\n",
1401 		    __func__);
1402 		error = ENXIO;
1403 		goto out;
1404 	}
1405 
1406 	id = mpr_mapping_get_raid_tid(sc, wwid, handle);
1407 	if (id == MPR_MAP_BAD_ID) {
1408 		printf("%s: could not get ID for volume with handle 0x%04x and "
1409 		    "WWID 0x%016llx\n", __func__, handle,
1410 		    (unsigned long long)wwid);
1411 		error = ENXIO;
1412 		goto out;
1413 	}
1414 
1415 	targ = &sassc->targets[id];
1416 	targ->tid = id;
1417 	targ->handle = handle;
1418 	targ->devname = wwid;
1419 	TAILQ_INIT(&targ->commands);
1420 	TAILQ_INIT(&targ->timedout_commands);
1421 	while (!SLIST_EMPTY(&targ->luns)) {
1422 		lun = SLIST_FIRST(&targ->luns);
1423 		SLIST_REMOVE_HEAD(&targ->luns, lun_link);
1424 		free(lun, M_MPR);
1425 	}
1426 	SLIST_INIT(&targ->luns);
1427 	mprsas_rescan_target(sc, targ);
1428 	mpr_dprint(sc, MPR_MAPPING, "RAID target id %d added (WWID = 0x%jx)\n",
1429 	    targ->tid, wwid);
1430 out:
1431 	mprsas_startup_decrement(sassc);
1432 	return (error);
1433 }
1434 
1435 /**
1436  * mprsas_SSU_to_SATA_devices
1437  * @sc: per adapter object
1438  *
1439  * Looks through the target list and issues a StartStopUnit SCSI command to each
1440  * SATA direct-access device.  This helps to ensure that data corruption is
1441  * avoided when the system is being shut down.  This must be called after the IR
1442  * System Shutdown RAID Action is sent if in IR mode.
1443  *
1444  * Return nothing.
1445  */
1446 static void
1447 mprsas_SSU_to_SATA_devices(struct mpr_softc *sc, int howto)
1448 {
1449 	struct mprsas_softc *sassc = sc->sassc;
1450 	union ccb *ccb;
1451 	path_id_t pathid = cam_sim_path(sassc->sim);
1452 	target_id_t targetid;
1453 	struct mprsas_target *target;
1454 	char path_str[64];
1455 	int timeout;
1456 
1457 	mpr_lock(sc);
1458 
1459 	/*
1460 	 * For each target, issue a StartStopUnit command to stop the device.
1461 	 */
1462 	sc->SSU_started = TRUE;
1463 	sc->SSU_refcount = 0;
1464 	for (targetid = 0; targetid < sc->max_devices; targetid++) {
1465 		target = &sassc->targets[targetid];
1466 		if (target->handle == 0x0) {
1467 			continue;
1468 		}
1469 
1470 		/*
1471 		 * The stop_at_shutdown flag will be set if this device is
1472 		 * a SATA direct-access end device.
1473 		 */
1474 		if (target->stop_at_shutdown) {
1475 			ccb = xpt_alloc_ccb_nowait();
1476 			if (ccb == NULL) {
1477 				mpr_dprint(sc, MPR_FAULT, "Unable to alloc CCB "
1478 				    "to stop unit.\n");
1479 				return;
1480 			}
1481 
1482 			if (xpt_create_path(&ccb->ccb_h.path, xpt_periph,
1483 			    pathid, targetid, CAM_LUN_WILDCARD) !=
1484 			    CAM_REQ_CMP) {
1485 				mpr_dprint(sc, MPR_ERROR, "Unable to create "
1486 				    "path to stop unit.\n");
1487 				xpt_free_ccb(ccb);
1488 				return;
1489 			}
1490 			xpt_path_string(ccb->ccb_h.path, path_str,
1491 			    sizeof(path_str));
1492 
1493 			mpr_dprint(sc, MPR_INFO, "Sending StopUnit: path %s "
1494 			    "handle %d\n", path_str, target->handle);
1495 
1496 			/*
1497 			 * Issue a START STOP UNIT command for the target.
1498 			 * Increment the SSU counter to be used to count the
1499 			 * number of required replies.
1500 			 */
1501 			mpr_dprint(sc, MPR_INFO, "Incrementing SSU count\n");
1502 			sc->SSU_refcount++;
1503 			ccb->ccb_h.target_id =
1504 			    xpt_path_target_id(ccb->ccb_h.path);
1505 			ccb->ccb_h.ppriv_ptr1 = sassc;
1506 			scsi_start_stop(&ccb->csio,
1507 			    /*retries*/0,
1508 			    mprsas_stop_unit_done,
1509 			    MSG_SIMPLE_Q_TAG,
1510 			    /*start*/FALSE,
1511 			    /*load/eject*/0,
1512 			    /*immediate*/FALSE,
1513 			    MPR_SENSE_LEN,
1514 			    /*timeout*/10000);
1515 			xpt_action(ccb);
1516 		}
1517 	}
1518 
1519 	mpr_unlock(sc);
1520 
1521 	/*
1522 	 * Timeout after 60 seconds by default or 10 seconds if howto has
1523 	 * RB_NOSYNC set which indicates we're likely handling a panic.
1524 	 */
1525 	timeout = 600;
1526 	if (howto & RB_NOSYNC)
1527 		timeout = 100;
1528 
1529 	/*
1530 	 * Wait until all of the SSU commands have completed or time
1531 	 * has expired. Pause for 100ms each time through.  If any
1532 	 * command times out, the target will be reset in the SCSI
1533 	 * command timeout routine.
1534 	 */
1535 	while (sc->SSU_refcount > 0) {
1536 		pause("mprwait", hz/10);
1537 		if (SCHEDULER_STOPPED())
1538 			xpt_sim_poll(sassc->sim);
1539 
1540 		if (--timeout == 0) {
1541 			mpr_dprint(sc, MPR_ERROR, "Time has expired waiting "
1542 			    "for SSU commands to complete.\n");
1543 			break;
1544 		}
1545 	}
1546 }
1547 
1548 static void
1549 mprsas_stop_unit_done(struct cam_periph *periph, union ccb *done_ccb)
1550 {
1551 	struct mprsas_softc *sassc;
1552 	char path_str[64];
1553 
1554 	if (done_ccb == NULL)
1555 		return;
1556 
1557 	sassc = (struct mprsas_softc *)done_ccb->ccb_h.ppriv_ptr1;
1558 
1559 	xpt_path_string(done_ccb->ccb_h.path, path_str, sizeof(path_str));
1560 	mpr_dprint(sassc->sc, MPR_INFO, "Completing stop unit for %s\n",
1561 	    path_str);
1562 
1563 	/*
1564 	 * Nothing more to do except free the CCB and path.  If the command
1565 	 * timed out, an abort reset, then target reset will be issued during
1566 	 * the SCSI Command process.
1567 	 */
1568 	xpt_free_path(done_ccb->ccb_h.path);
1569 	xpt_free_ccb(done_ccb);
1570 }
1571 
1572 /**
1573  * mprsas_ir_shutdown - IR shutdown notification
1574  * @sc: per adapter object
1575  *
1576  * Sending RAID Action to alert the Integrated RAID subsystem of the IOC that
1577  * the host system is shutting down.
1578  *
1579  * Return nothing.
1580  */
1581 void
1582 mprsas_ir_shutdown(struct mpr_softc *sc, int howto)
1583 {
1584 	u16 volume_mapping_flags;
1585 	u16 ioc_pg8_flags = le16toh(sc->ioc_pg8.Flags);
1586 	struct dev_mapping_table *mt_entry;
1587 	u32 start_idx, end_idx;
1588 	unsigned int id, found_volume = 0;
1589 	struct mpr_command *cm;
1590 	Mpi2RaidActionRequest_t	*action;
1591 	target_id_t targetid;
1592 	struct mprsas_target *target;
1593 
1594 	mpr_dprint(sc, MPR_TRACE, "%s\n", __func__);
1595 
1596 	/* is IR firmware build loaded? */
1597 	if (!sc->ir_firmware)
1598 		goto out;
1599 
1600 	/* are there any volumes?  Look at IR target IDs. */
1601 	// TODO-later, this should be looked up in the RAID config structure
1602 	// when it is implemented.
1603 	volume_mapping_flags = le16toh(sc->ioc_pg8.IRVolumeMappingFlags) &
1604 	    MPI2_IOCPAGE8_IRFLAGS_MASK_VOLUME_MAPPING_MODE;
1605 	if (volume_mapping_flags == MPI2_IOCPAGE8_IRFLAGS_LOW_VOLUME_MAPPING) {
1606 		start_idx = 0;
1607 		if (ioc_pg8_flags & MPI2_IOCPAGE8_FLAGS_RESERVED_TARGETID_0)
1608 			start_idx = 1;
1609 	} else
1610 		start_idx = sc->max_devices - sc->max_volumes;
1611 	end_idx = start_idx + sc->max_volumes - 1;
1612 
1613 	for (id = start_idx; id < end_idx; id++) {
1614 		mt_entry = &sc->mapping_table[id];
1615 		if ((mt_entry->physical_id != 0) &&
1616 		    (mt_entry->missing_count == 0)) {
1617 			found_volume = 1;
1618 			break;
1619 		}
1620 	}
1621 
1622 	if (!found_volume)
1623 		goto out;
1624 
1625 	if ((cm = mpr_alloc_command(sc)) == NULL) {
1626 		printf("%s: command alloc failed\n", __func__);
1627 		goto out;
1628 	}
1629 
1630 	action = (MPI2_RAID_ACTION_REQUEST *)cm->cm_req;
1631 	action->Function = MPI2_FUNCTION_RAID_ACTION;
1632 	action->Action = MPI2_RAID_ACTION_SYSTEM_SHUTDOWN_INITIATED;
1633 	cm->cm_desc.Default.RequestFlags = MPI2_REQ_DESCRIPT_FLAGS_DEFAULT_TYPE;
1634 	mpr_lock(sc);
1635 	mpr_wait_command(sc, &cm, 5, CAN_SLEEP);
1636 	mpr_unlock(sc);
1637 
1638 	/*
1639 	 * Don't check for reply, just leave.
1640 	 */
1641 	if (cm)
1642 		mpr_free_command(sc, cm);
1643 
1644 out:
1645 	/*
1646 	 * All of the targets must have the correct value set for
1647 	 * 'stop_at_shutdown' for the current 'enable_ssu' sysctl variable.
1648 	 *
1649 	 * The possible values for the 'enable_ssu' variable are:
1650 	 * 0: disable to SSD and HDD
1651 	 * 1: disable only to HDD (default)
1652 	 * 2: disable only to SSD
1653 	 * 3: enable to SSD and HDD
1654 	 * anything else will default to 1.
1655 	 */
1656 	for (targetid = 0; targetid < sc->max_devices; targetid++) {
1657 		target = &sc->sassc->targets[targetid];
1658 		if (target->handle == 0x0) {
1659 			continue;
1660 		}
1661 
1662 		if (target->supports_SSU) {
1663 			switch (sc->enable_ssu) {
1664 			case MPR_SSU_DISABLE_SSD_DISABLE_HDD:
1665 				target->stop_at_shutdown = FALSE;
1666 				break;
1667 			case MPR_SSU_DISABLE_SSD_ENABLE_HDD:
1668 				target->stop_at_shutdown = TRUE;
1669 				if (target->flags & MPR_TARGET_IS_SATA_SSD) {
1670 					target->stop_at_shutdown = FALSE;
1671 				}
1672 				break;
1673 			case MPR_SSU_ENABLE_SSD_ENABLE_HDD:
1674 				target->stop_at_shutdown = TRUE;
1675 				break;
1676 			case MPR_SSU_ENABLE_SSD_DISABLE_HDD:
1677 			default:
1678 				target->stop_at_shutdown = TRUE;
1679 				if ((target->flags &
1680 				    MPR_TARGET_IS_SATA_SSD) == 0) {
1681 					target->stop_at_shutdown = FALSE;
1682 				}
1683 				break;
1684 			}
1685 		}
1686 	}
1687 	mprsas_SSU_to_SATA_devices(sc, howto);
1688 }
1689