xref: /freebsd/sys/dev/mps/mps_sas_lsi.c (revision 40427cca7a9ae77b095936fb1954417c290cfb17)
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_DPRINT_EVENT(sc, sas, 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),
221 				    phy->LinkRate)){
222 					mps_dprint(sc, MPS_ERROR, "%s: "
223 					    "failed to add device with handle "
224 					    "0x%x\n", __func__,
225 					    le16toh(phy->AttachedDevHandle));
226 					mpssas_prepare_remove(sassc, le16toh(
227 						phy->AttachedDevHandle));
228 				}
229 				break;
230 			case MPI2_EVENT_SAS_TOPO_RC_TARG_NOT_RESPONDING:
231 				mpssas_prepare_remove(sassc,le16toh(
232 					phy->AttachedDevHandle));
233 				break;
234 			case MPI2_EVENT_SAS_TOPO_RC_PHY_CHANGED:
235 			case MPI2_EVENT_SAS_TOPO_RC_NO_CHANGE:
236 			case MPI2_EVENT_SAS_TOPO_RC_DELAY_NOT_RESPONDING:
237 			default:
238 				break;
239 			}
240 		}
241 		/*
242 		 * refcount was incremented for this event in
243 		 * mpssas_evt_handler.  Decrement it here because the event has
244 		 * been processed.
245 		 */
246 		mpssas_startup_decrement(sassc);
247 		break;
248 	}
249 	case MPI2_EVENT_SAS_DISCOVERY:
250 	{
251 		MPI2_EVENT_DATA_SAS_DISCOVERY *data;
252 
253 		data = (MPI2_EVENT_DATA_SAS_DISCOVERY *)fw_event->event_data;
254 
255 		if (data->ReasonCode & MPI2_EVENT_SAS_DISC_RC_STARTED)
256 			mps_dprint(sc, MPS_TRACE,"SAS discovery start event\n");
257 		if (data->ReasonCode & MPI2_EVENT_SAS_DISC_RC_COMPLETED) {
258 			mps_dprint(sc, MPS_TRACE,"SAS discovery stop event\n");
259 			sassc->flags &= ~MPSSAS_IN_DISCOVERY;
260 			mpssas_discovery_end(sassc);
261 		}
262 		break;
263 	}
264 	case MPI2_EVENT_SAS_ENCL_DEVICE_STATUS_CHANGE:
265 	{
266 		Mpi2EventDataSasEnclDevStatusChange_t *data;
267 		data = (Mpi2EventDataSasEnclDevStatusChange_t *)
268 		    fw_event->event_data;
269 		mps_mapping_enclosure_dev_status_change_event(sc,
270 		    fw_event->event_data);
271 		break;
272 	}
273 	case MPI2_EVENT_IR_CONFIGURATION_CHANGE_LIST:
274 	{
275 		Mpi2EventIrConfigElement_t *element;
276 		int i;
277 		u8 foreign_config;
278 		Mpi2EventDataIrConfigChangeList_t *event_data;
279 		struct mpssas_target *targ;
280 		unsigned int id;
281 
282 		event_data = fw_event->event_data;
283 		foreign_config = (le32toh(event_data->Flags) &
284 		    MPI2_EVENT_IR_CHANGE_FLAGS_FOREIGN_CONFIG) ? 1 : 0;
285 
286 		element =
287 		    (Mpi2EventIrConfigElement_t *)&event_data->ConfigElement[0];
288 		id = mps_mapping_get_raid_tid_from_handle(sc,
289 		    element->VolDevHandle);
290 
291 		mps_mapping_ir_config_change_event(sc, event_data);
292 
293 		for (i = 0; i < event_data->NumElements; i++, element++) {
294 			switch (element->ReasonCode) {
295 			case MPI2_EVENT_IR_CHANGE_RC_VOLUME_CREATED:
296 			case MPI2_EVENT_IR_CHANGE_RC_ADDED:
297 				if (!foreign_config) {
298 					if (mpssas_volume_add(sc,
299 					    le16toh(element->VolDevHandle))){
300 						printf("%s: failed to add RAID "
301 						    "volume with handle 0x%x\n",
302 						    __func__, le16toh(element->
303 						    VolDevHandle));
304 					}
305 				}
306 				break;
307 			case MPI2_EVENT_IR_CHANGE_RC_VOLUME_DELETED:
308 			case MPI2_EVENT_IR_CHANGE_RC_REMOVED:
309 				/*
310 				 * Rescan after volume is deleted or removed.
311 				 */
312 				if (!foreign_config) {
313 					if (id == MPS_MAP_BAD_ID) {
314 						printf("%s: could not get ID "
315 						    "for volume with handle "
316 						    "0x%04x\n", __func__,
317 						    le16toh(element->VolDevHandle));
318 						break;
319 					}
320 
321 					targ = &sassc->targets[id];
322 					targ->handle = 0x0;
323 					targ->encl_slot = 0x0;
324 					targ->encl_handle = 0x0;
325 					targ->exp_dev_handle = 0x0;
326 					targ->phy_num = 0x0;
327 					targ->linkrate = 0x0;
328 					mpssas_rescan_target(sc, targ);
329 					printf("RAID target id 0x%x removed\n",
330 					    targ->tid);
331 				}
332 				break;
333 			case MPI2_EVENT_IR_CHANGE_RC_PD_CREATED:
334 			case MPI2_EVENT_IR_CHANGE_RC_HIDE:
335 				/*
336 				 * Phys Disk of a volume has been created.  Hide
337 				 * it from the OS.
338 				 */
339 				targ = mpssas_find_target_by_handle(sassc, 0,
340 				    element->PhysDiskDevHandle);
341 				if (targ == NULL)
342 					break;
343 
344 				/*
345 				 * Set raid component flags only if it is not
346 				 * WD. OR WrapDrive with
347 				 * WD_HIDE_ALWAYS/WD_HIDE_IF_VOLUME is set in
348 				 * NVRAM
349 				 */
350 				if((!sc->WD_available) ||
351 				((sc->WD_available &&
352 				(sc->WD_hide_expose == MPS_WD_HIDE_ALWAYS)) ||
353 				(sc->WD_valid_config && (sc->WD_hide_expose ==
354 				MPS_WD_HIDE_IF_VOLUME)))) {
355 					targ->flags |= MPS_TARGET_FLAGS_RAID_COMPONENT;
356 				}
357 				mpssas_rescan_target(sc, targ);
358 
359 				break;
360 			case MPI2_EVENT_IR_CHANGE_RC_PD_DELETED:
361 				/*
362 				 * Phys Disk of a volume has been deleted.
363 				 * Expose it to the OS.
364 				 */
365 				if (mpssas_add_device(sc,
366 				    le16toh(element->PhysDiskDevHandle), 0)){
367 					printf("%s: failed to add device with "
368 					    "handle 0x%x\n", __func__,
369 					    le16toh(element->PhysDiskDevHandle));
370 					mpssas_prepare_remove(sassc, le16toh(element->
371 					    PhysDiskDevHandle));
372 				}
373 				break;
374 			}
375 		}
376 		/*
377 		 * refcount was incremented for this event in
378 		 * mpssas_evt_handler.  Decrement it here because the event has
379 		 * been processed.
380 		 */
381 		mpssas_startup_decrement(sassc);
382 		break;
383 	}
384 	case MPI2_EVENT_IR_VOLUME:
385 	{
386 		Mpi2EventDataIrVolume_t *event_data = fw_event->event_data;
387 
388 		/*
389 		 * Informational only.
390 		 */
391 		mps_dprint(sc, MPS_EVENT, "Received IR Volume event:\n");
392 		switch (event_data->ReasonCode) {
393 		case MPI2_EVENT_IR_VOLUME_RC_SETTINGS_CHANGED:
394   			mps_dprint(sc, MPS_EVENT, "   Volume Settings "
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_STATUS_FLAGS_CHANGED:
401   			mps_dprint(sc, MPS_EVENT, "   Volume Status "
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 			break;
407 		case MPI2_EVENT_IR_VOLUME_RC_STATE_CHANGED:
408   			mps_dprint(sc, MPS_EVENT, "   Volume State "
409   			    "changed from 0x%x to 0x%x for Volome with "
410  			    "handle 0x%x", le32toh(event_data->PreviousValue),
411  			    le32toh(event_data->NewValue),
412  			    le16toh(event_data->VolDevHandle));
413 				u32 state;
414 				struct mpssas_target *targ;
415 				state = le32toh(event_data->NewValue);
416 				switch (state) {
417 				case MPI2_RAID_VOL_STATE_MISSING:
418 				case MPI2_RAID_VOL_STATE_FAILED:
419 					mpssas_prepare_volume_remove(sassc, event_data->
420 							VolDevHandle);
421 					break;
422 
423 				case MPI2_RAID_VOL_STATE_ONLINE:
424 				case MPI2_RAID_VOL_STATE_DEGRADED:
425 				case MPI2_RAID_VOL_STATE_OPTIMAL:
426 					targ = mpssas_find_target_by_handle(sassc, 0, event_data->VolDevHandle);
427 					if (targ) {
428 						printf("%s %d: Volume handle 0x%x is already added \n",
429 							       	__func__, __LINE__ , event_data->VolDevHandle);
430 						break;
431 					}
432 					if (mpssas_volume_add(sc, le16toh(event_data->VolDevHandle))) {
433 						printf("%s: failed to add RAID "
434 							"volume with handle 0x%x\n",
435 							__func__, le16toh(event_data->
436 							VolDevHandle));
437 					}
438 					break;
439 				default:
440 					break;
441 				}
442 			break;
443 		default:
444 			break;
445 		}
446 		break;
447 	}
448 	case MPI2_EVENT_IR_PHYSICAL_DISK:
449 	{
450 		Mpi2EventDataIrPhysicalDisk_t *event_data =
451 		    fw_event->event_data;
452 		struct mpssas_target *targ;
453 
454 		/*
455 		 * Informational only.
456 		 */
457 		mps_dprint(sc, MPS_EVENT, "Received IR Phys Disk event:\n");
458 		switch (event_data->ReasonCode) {
459 		case MPI2_EVENT_IR_PHYSDISK_RC_SETTINGS_CHANGED:
460   			mps_dprint(sc, MPS_EVENT, "   Phys Disk Settings "
461   			    "changed from 0x%x to 0x%x for Phys Disk Number "
462   			    "%d and handle 0x%x at Enclosure handle 0x%x, Slot "
463  			    "%d", le32toh(event_data->PreviousValue),
464  			    le32toh(event_data->NewValue),
465  				event_data->PhysDiskNum,
466  			    le16toh(event_data->PhysDiskDevHandle),
467  			    le16toh(event_data->EnclosureHandle), le16toh(event_data->Slot));
468 			break;
469 		case MPI2_EVENT_IR_PHYSDISK_RC_STATUS_FLAGS_CHANGED:
470   			mps_dprint(sc, MPS_EVENT, "   Phys Disk Status changed "
471   			    "from 0x%x to 0x%x for Phys Disk Number %d and "
472   			    "handle 0x%x at Enclosure handle 0x%x, Slot %d",
473  				le32toh(event_data->PreviousValue),
474  			    le32toh(event_data->NewValue), event_data->PhysDiskNum,
475  			    le16toh(event_data->PhysDiskDevHandle),
476  			    le16toh(event_data->EnclosureHandle), le16toh(event_data->Slot));
477 			break;
478 		case MPI2_EVENT_IR_PHYSDISK_RC_STATE_CHANGED:
479   			mps_dprint(sc, MPS_EVENT, "   Phys Disk State changed "
480   			    "from 0x%x to 0x%x for Phys Disk Number %d and "
481   			    "handle 0x%x at Enclosure handle 0x%x, Slot %d",
482  				le32toh(event_data->PreviousValue),
483  			    le32toh(event_data->NewValue), event_data->PhysDiskNum,
484  			    le16toh(event_data->PhysDiskDevHandle),
485  			    le16toh(event_data->EnclosureHandle), le16toh(event_data->Slot));
486 			switch (event_data->NewValue) {
487 				case MPI2_RAID_PD_STATE_ONLINE:
488 				case MPI2_RAID_PD_STATE_DEGRADED:
489 				case MPI2_RAID_PD_STATE_REBUILDING:
490 				case MPI2_RAID_PD_STATE_OPTIMAL:
491 				case MPI2_RAID_PD_STATE_HOT_SPARE:
492 					targ = mpssas_find_target_by_handle(sassc, 0,
493 							event_data->PhysDiskDevHandle);
494 					if (targ) {
495 						if(!sc->WD_available) {
496 							targ->flags |= MPS_TARGET_FLAGS_RAID_COMPONENT;
497 							printf("%s %d: Found Target for handle 0x%x.  \n",
498 							__func__, __LINE__ , event_data->PhysDiskDevHandle);
499 						} else if ((sc->WD_available &&
500 							(sc->WD_hide_expose == MPS_WD_HIDE_ALWAYS)) ||
501         						(sc->WD_valid_config && (sc->WD_hide_expose ==
502         						MPS_WD_HIDE_IF_VOLUME))) {
503 							targ->flags |= MPS_TARGET_FLAGS_RAID_COMPONENT;
504 							printf("%s %d: WD: Found Target for handle 0x%x.  \n",
505 							__func__, __LINE__ , event_data->PhysDiskDevHandle);
506 						}
507  					}
508 				break;
509 				case MPI2_RAID_PD_STATE_OFFLINE:
510 				case MPI2_RAID_PD_STATE_NOT_CONFIGURED:
511 				case MPI2_RAID_PD_STATE_NOT_COMPATIBLE:
512 				default:
513 					targ = mpssas_find_target_by_handle(sassc, 0,
514 							event_data->PhysDiskDevHandle);
515 					if (targ) {
516 						targ->flags |= ~MPS_TARGET_FLAGS_RAID_COMPONENT;
517 						printf("%s %d: Found Target for handle 0x%x.  \n",
518 						__func__, __LINE__ , event_data->PhysDiskDevHandle);
519 					}
520 				break;
521 			}
522 		default:
523 			break;
524 		}
525 		break;
526 	}
527 	case MPI2_EVENT_IR_OPERATION_STATUS:
528 	{
529 		Mpi2EventDataIrOperationStatus_t *event_data =
530 		    fw_event->event_data;
531 
532 		/*
533 		 * Informational only.
534 		 */
535 		mps_dprint(sc, MPS_EVENT, "Received IR Op Status event:\n");
536 		mps_dprint(sc, MPS_EVENT, "   RAID Operation of %d is %d "
537 		    "percent complete for Volume with handle 0x%x",
538 		    event_data->RAIDOperation, event_data->PercentComplete,
539 		    le16toh(event_data->VolDevHandle));
540 		break;
541 	}
542 	case MPI2_EVENT_LOG_ENTRY_ADDED:
543 	{
544 		pMpi2EventDataLogEntryAdded_t	logEntry;
545 		uint16_t			logQualifier;
546 		uint8_t				logCode;
547 
548 		logEntry = (pMpi2EventDataLogEntryAdded_t)fw_event->event_data;
549 		logQualifier = logEntry->LogEntryQualifier;
550 
551 		if (logQualifier == MPI2_WD_LOG_ENTRY) {
552 			logCode = logEntry->LogData[0];
553 
554 			switch (logCode) {
555 			case MPI2_WD_SSD_THROTTLING:
556 				printf("WarpDrive Warning: IO Throttling has "
557 				    "occurred in the WarpDrive subsystem. "
558 				    "Check WarpDrive documentation for "
559 				    "additional details\n");
560 				break;
561 			case MPI2_WD_DRIVE_LIFE_WARN:
562 				printf("WarpDrive Warning: Program/Erase "
563 				    "Cycles for the WarpDrive subsystem in "
564 				    "degraded range. Check WarpDrive "
565 				    "documentation for additional details\n");
566 				break;
567 			case MPI2_WD_DRIVE_LIFE_DEAD:
568 				printf("WarpDrive Fatal Error: There are no "
569 				    "Program/Erase Cycles for the WarpDrive "
570 				    "subsystem. The storage device will be in "
571 				    "read-only mode. Check WarpDrive "
572 				    "documentation for additional details\n");
573 				break;
574 			case MPI2_WD_RAIL_MON_FAIL:
575 				printf("WarpDrive Fatal Error: The Backup Rail "
576 				    "Monitor has failed on the WarpDrive "
577 				    "subsystem. Check WarpDrive documentation "
578 				    "for additional details\n");
579 				break;
580 			default:
581 				break;
582 			}
583 		}
584 		break;
585 	}
586 	case MPI2_EVENT_SAS_DEVICE_STATUS_CHANGE:
587 	case MPI2_EVENT_SAS_BROADCAST_PRIMITIVE:
588 	default:
589 		mps_dprint(sc, MPS_TRACE,"Unhandled event 0x%0X\n",
590 		    fw_event->event);
591 		break;
592 
593 	}
594 	mps_dprint(sc, MPS_EVENT, "(%d)->(%s) Event Free: [%x]\n",event_count,__func__, fw_event->event);
595 	mpssas_fw_event_free(sc, fw_event);
596 }
597 
598 void
599 mpssas_firmware_event_work(void *arg, int pending)
600 {
601 	struct mps_fw_event_work *fw_event;
602 	struct mps_softc *sc;
603 
604 	sc = (struct mps_softc *)arg;
605 	mps_lock(sc);
606 	while ((fw_event = TAILQ_FIRST(&sc->sassc->ev_queue)) != NULL) {
607 		TAILQ_REMOVE(&sc->sassc->ev_queue, fw_event, ev_link);
608 		mpssas_fw_work(sc, fw_event);
609 	}
610 	mps_unlock(sc);
611 }
612 
613 static int
614 mpssas_add_device(struct mps_softc *sc, u16 handle, u8 linkrate){
615 	char devstring[80];
616 	struct mpssas_softc *sassc;
617 	struct mpssas_target *targ;
618 	Mpi2ConfigReply_t mpi_reply;
619 	Mpi2SasDevicePage0_t config_page;
620 	uint64_t sas_address;
621 	uint64_t parent_sas_address = 0;
622 	u32 device_info, parent_devinfo = 0;
623 	unsigned int id;
624 	int ret = 1, error = 0, i;
625 	struct mpssas_lun *lun;
626 	u8 is_SATA_SSD = 0;
627 	struct mps_command *cm;
628 
629 	sassc = sc->sassc;
630 	mpssas_startup_increment(sassc);
631 	if ((mps_config_get_sas_device_pg0(sc, &mpi_reply, &config_page,
632 	     MPI2_SAS_DEVICE_PGAD_FORM_HANDLE, handle))) {
633 		printf("%s: error reading SAS device page0\n", __func__);
634 		error = ENXIO;
635 		goto out;
636 	}
637 
638 	device_info = le32toh(config_page.DeviceInfo);
639 
640 	if (((device_info & MPI2_SAS_DEVICE_INFO_SMP_TARGET) == 0)
641 	 && (le16toh(config_page.ParentDevHandle) != 0)) {
642 		Mpi2ConfigReply_t tmp_mpi_reply;
643 		Mpi2SasDevicePage0_t parent_config_page;
644 
645 		if ((mps_config_get_sas_device_pg0(sc, &tmp_mpi_reply,
646 		     &parent_config_page, MPI2_SAS_DEVICE_PGAD_FORM_HANDLE,
647 		     le16toh(config_page.ParentDevHandle)))) {
648 			mps_dprint(sc, MPS_MAPPING|MPS_FAULT,
649 			    "%s: error reading SAS device %#x page0\n",
650 			    __func__, le16toh(config_page.ParentDevHandle));
651 		} else {
652 			parent_sas_address = parent_config_page.SASAddress.High;
653 			parent_sas_address = (parent_sas_address << 32) |
654 				parent_config_page.SASAddress.Low;
655 			parent_devinfo = le32toh(parent_config_page.DeviceInfo);
656 		}
657 	}
658 	/* TODO Check proper endianness */
659 	sas_address = config_page.SASAddress.High;
660 	sas_address = (sas_address << 32) | config_page.SASAddress.Low;
661         mps_dprint(sc, MPS_MAPPING, "Handle 0x%04x SAS Address from SAS device "
662             "page0 = %jx\n", handle, sas_address);
663 
664 	/*
665 	 * Always get SATA Identify information because this is used to
666 	 * determine if Start/Stop Unit should be sent to the drive when the
667 	 * system is shutdown.
668 	 */
669 	if (device_info & MPI2_SAS_DEVICE_INFO_SATA_DEVICE) {
670 		ret = mpssas_get_sas_address_for_sata_disk(sc, &sas_address,
671 		    handle, device_info, &is_SATA_SSD);
672 		if (ret) {
673 			mps_dprint(sc, MPS_MAPPING|MPS_ERROR,
674 			    "%s: failed to get disk type (SSD or HDD) for SATA "
675 			    "device with handle 0x%04x\n",
676 			    __func__, handle);
677 		} else {
678 			mps_dprint(sc, MPS_MAPPING, "Handle 0x%04x SAS Address "
679 			    "from SATA device = %jx\n", handle, sas_address);
680 		}
681 	}
682 
683 	/*
684 	 * use_phynum:
685 	 *  1 - use the PhyNum field as a fallback to the mapping logic
686 	 *  0 - never use the PhyNum field
687 	 * -1 - only use the PhyNum field
688 	 *
689 	 * Note that using the Phy number to map a device can cause device adds
690 	 * to fail if multiple enclosures/expanders are in the topology. For
691 	 * example, if two devices are in the same slot number in two different
692 	 * enclosures within the topology, only one of those devices will be
693 	 * added. PhyNum mapping should not be used if multiple enclosures are
694 	 * in the topology.
695 	 */
696 	id = MPS_MAP_BAD_ID;
697 	if (sc->use_phynum != -1)
698 		id = mps_mapping_get_tid(sc, sas_address, handle);
699 	if (id == MPS_MAP_BAD_ID) {
700 		if ((sc->use_phynum == 0)
701 		 || ((id = config_page.PhyNum) > sassc->maxtargets)) {
702 			mps_dprint(sc, MPS_INFO, "failure at %s:%d/%s()! "
703 			    "Could not get ID for device with handle 0x%04x\n",
704 			    __FILE__, __LINE__, __func__, handle);
705 			error = ENXIO;
706 			goto out;
707 		}
708 	}
709 	mps_dprint(sc, MPS_MAPPING, "%s: Target ID for added device is %d.\n",
710 	    __func__, id);
711 
712 	/*
713 	 * Only do the ID check and reuse check if the target is not from a
714 	 * RAID Component. For Physical Disks of a Volume, the ID will be reused
715 	 * when a volume is deleted because the mapping entry for the PD will
716 	 * still be in the mapping table. The ID check should not be done here
717 	 * either since this PD is already being used.
718 	 */
719 	targ = &sassc->targets[id];
720 	if (!(targ->flags & MPS_TARGET_FLAGS_RAID_COMPONENT)) {
721 		if (mpssas_check_id(sassc, id) != 0) {
722 			mps_dprint(sc, MPS_MAPPING|MPS_INFO,
723 			    "Excluding target id %d\n", id);
724 			error = ENXIO;
725 			goto out;
726 		}
727 
728 		if (targ->handle != 0x0) {
729 			mps_dprint(sc, MPS_MAPPING, "Attempting to reuse "
730 			    "target id %d handle 0x%04x\n", id, targ->handle);
731 			error = ENXIO;
732 			goto out;
733 		}
734 	}
735 
736 	targ->devinfo = device_info;
737 	targ->devname = le32toh(config_page.DeviceName.High);
738 	targ->devname = (targ->devname << 32) |
739 	    le32toh(config_page.DeviceName.Low);
740 	targ->encl_handle = le16toh(config_page.EnclosureHandle);
741 	targ->encl_slot = le16toh(config_page.Slot);
742 	targ->handle = handle;
743 	targ->parent_handle = le16toh(config_page.ParentDevHandle);
744 	targ->sasaddr = mps_to_u64(&config_page.SASAddress);
745 	targ->parent_sasaddr = le64toh(parent_sas_address);
746 	targ->parent_devinfo = parent_devinfo;
747 	targ->tid = id;
748 	targ->linkrate = (linkrate>>4);
749 	targ->flags = 0;
750 	if (is_SATA_SSD) {
751 		targ->flags = MPS_TARGET_IS_SATA_SSD;
752 	}
753 	TAILQ_INIT(&targ->commands);
754 	TAILQ_INIT(&targ->timedout_commands);
755 	while(!SLIST_EMPTY(&targ->luns)) {
756 		lun = SLIST_FIRST(&targ->luns);
757 		SLIST_REMOVE_HEAD(&targ->luns, lun_link);
758 		free(lun, M_MPT2);
759 	}
760 	SLIST_INIT(&targ->luns);
761 
762 	mps_describe_devinfo(targ->devinfo, devstring, 80);
763 	mps_dprint(sc, MPS_MAPPING, "Found device <%s> <%s> <0x%04x> <%d/%d>\n",
764 	    devstring, mps_describe_table(mps_linkrate_names, targ->linkrate),
765 	    targ->handle, targ->encl_handle, targ->encl_slot);
766 
767 #if __FreeBSD_version < 1000039
768 	if ((sassc->flags & MPSSAS_IN_STARTUP) == 0)
769 #endif
770 		mpssas_rescan_target(sc, targ);
771 	mps_dprint(sc, MPS_MAPPING, "Target id 0x%x added\n", targ->tid);
772 
773 	/*
774 	 * Check all commands to see if the SATA_ID_TIMEOUT flag has been set.
775 	 * If so, send a Target Reset TM to the target that was just created.
776 	 * An Abort Task TM should be used instead of a Target Reset, but that
777 	 * would be much more difficult because targets have not been fully
778 	 * discovered yet, and LUN's haven't been setup.  So, just reset the
779 	 * target instead of the LUN.
780 	 */
781 	for (i = 1; i < sc->num_reqs; i++) {
782 		cm = &sc->commands[i];
783 		if (cm->cm_flags & MPS_CM_FLAGS_SATA_ID_TIMEOUT) {
784 			targ->timeouts++;
785 			cm->cm_state = MPS_CM_STATE_TIMEDOUT;
786 
787 			if ((targ->tm = mpssas_alloc_tm(sc)) != NULL) {
788 				mps_dprint(sc, MPS_INFO, "%s: sending Target "
789 				    "Reset for stuck SATA identify command "
790 				    "(cm = %p)\n", __func__, cm);
791 				targ->tm->cm_targ = targ;
792 				mpssas_send_reset(sc, targ->tm,
793 				    MPI2_SCSITASKMGMT_TASKTYPE_TARGET_RESET);
794 			} else {
795 				mps_dprint(sc, MPS_ERROR, "Failed to allocate "
796 				    "tm for Target Reset after SATA ID command "
797 				    "timed out (cm %p)\n", cm);
798 			}
799 			/*
800 			 * No need to check for more since the target is
801 			 * already being reset.
802 			 */
803 			break;
804 		}
805 	}
806 out:
807 	/*
808 	 * Free the commands that may not have been freed from the SATA ID call
809 	 */
810 	for (i = 1; i < sc->num_reqs; i++) {
811 		cm = &sc->commands[i];
812 		if (cm->cm_flags & MPS_CM_FLAGS_SATA_ID_TIMEOUT) {
813 			mps_free_command(sc, cm);
814 		}
815 	}
816 	mpssas_startup_decrement(sassc);
817 	return (error);
818 }
819 
820 int
821 mpssas_get_sas_address_for_sata_disk(struct mps_softc *sc,
822     u64 *sas_address, u16 handle, u32 device_info, u8 *is_SATA_SSD)
823 {
824 	Mpi2SataPassthroughReply_t mpi_reply;
825 	int i, rc, try_count;
826 	u32 *bufferptr;
827 	union _sata_sas_address hash_address;
828 	struct _ata_identify_device_data ata_identify;
829 	u8 buffer[MPT2SAS_MN_LEN + MPT2SAS_SN_LEN];
830 	u32 ioc_status;
831 	u8 sas_status;
832 
833 	memset(&ata_identify, 0, sizeof(ata_identify));
834 	try_count = 0;
835 	do {
836 		rc = mpssas_get_sata_identify(sc, handle, &mpi_reply,
837 		    (char *)&ata_identify, sizeof(ata_identify), device_info);
838 		try_count++;
839 		ioc_status = le16toh(mpi_reply.IOCStatus)
840 		    & MPI2_IOCSTATUS_MASK;
841 		sas_status = mpi_reply.SASStatus;
842 		switch (ioc_status) {
843 		case MPI2_IOCSTATUS_SUCCESS:
844 			break;
845 		case MPI2_IOCSTATUS_SCSI_PROTOCOL_ERROR:
846 			/* No sense sleeping.  this error won't get better */
847 			break;
848 		default:
849 			if (sc->spinup_wait_time > 0) {
850 				mps_dprint(sc, MPS_INFO, "Sleeping %d seconds "
851 				    "after SATA ID error to wait for spinup\n",
852 				    sc->spinup_wait_time);
853 				msleep(&sc->msleep_fake_chan, &sc->mps_mtx, 0,
854 				    "mpsid", sc->spinup_wait_time * hz);
855 			}
856 		}
857 	} while (((rc && (rc != EWOULDBLOCK)) ||
858 	    	 (ioc_status &&
859 		  (ioc_status != MPI2_IOCSTATUS_SCSI_PROTOCOL_ERROR))
860 	       || sas_status) && (try_count < 5));
861 
862 	if (rc == 0 && !ioc_status && !sas_status) {
863 		mps_dprint(sc, MPS_MAPPING, "%s: got SATA identify "
864 		    "successfully for handle = 0x%x with try_count = %d\n",
865 		    __func__, handle, try_count);
866 	} else {
867 		mps_dprint(sc, MPS_MAPPING, "%s: handle = 0x%x failed\n",
868 		    __func__, handle);
869 		return -1;
870 	}
871 	/* Copy & byteswap the 40 byte model number to a buffer */
872 	for (i = 0; i < MPT2SAS_MN_LEN; i += 2) {
873 		buffer[i] = ((u8 *)ata_identify.model_number)[i + 1];
874 		buffer[i + 1] = ((u8 *)ata_identify.model_number)[i];
875 	}
876 	/* Copy & byteswap the 20 byte serial number to a buffer */
877 	for (i = 0; i < MPT2SAS_SN_LEN; i += 2) {
878 		buffer[MPT2SAS_MN_LEN + i] =
879 		    ((u8 *)ata_identify.serial_number)[i + 1];
880 		buffer[MPT2SAS_MN_LEN + i + 1] =
881 		    ((u8 *)ata_identify.serial_number)[i];
882 	}
883 	bufferptr = (u32 *)buffer;
884 	/* There are 60 bytes to hash down to 8. 60 isn't divisible by 8,
885 	 * so loop through the first 56 bytes (7*8),
886 	 * and then add in the last dword.
887 	 */
888 	hash_address.word.low  = 0;
889 	hash_address.word.high = 0;
890 	for (i = 0; (i < ((MPT2SAS_MN_LEN+MPT2SAS_SN_LEN)/8)); i++) {
891 		hash_address.word.low += *bufferptr;
892 		bufferptr++;
893 		hash_address.word.high += *bufferptr;
894 		bufferptr++;
895 	}
896 	/* Add the last dword */
897 	hash_address.word.low += *bufferptr;
898 	/* Make sure the hash doesn't start with 5, because it could clash
899 	 * with a SAS address. Change 5 to a D.
900 	 */
901 	if ((hash_address.word.high & 0x000000F0) == (0x00000050))
902 		hash_address.word.high |= 0x00000080;
903 	*sas_address = (u64)hash_address.wwid[0] << 56 |
904 	    (u64)hash_address.wwid[1] << 48 | (u64)hash_address.wwid[2] << 40 |
905 	    (u64)hash_address.wwid[3] << 32 | (u64)hash_address.wwid[4] << 24 |
906 	    (u64)hash_address.wwid[5] << 16 | (u64)hash_address.wwid[6] <<  8 |
907 	    (u64)hash_address.wwid[7];
908 	if (ata_identify.rotational_speed == 1) {
909 		*is_SATA_SSD = 1;
910 	}
911 
912 	return 0;
913 }
914 
915 static int
916 mpssas_get_sata_identify(struct mps_softc *sc, u16 handle,
917     Mpi2SataPassthroughReply_t *mpi_reply, char *id_buffer, int sz, u32 devinfo)
918 {
919 	Mpi2SataPassthroughRequest_t *mpi_request;
920 	Mpi2SataPassthroughReply_t *reply = NULL;
921 	struct mps_command *cm;
922 	char *buffer;
923 	int error = 0;
924 
925 	buffer = malloc( sz, M_MPT2, M_NOWAIT | M_ZERO);
926 	if (!buffer)
927 		return ENOMEM;
928 
929 	if ((cm = mps_alloc_command(sc)) == NULL) {
930 		free(buffer, M_MPT2);
931 		return (EBUSY);
932 	}
933 	mpi_request = (MPI2_SATA_PASSTHROUGH_REQUEST *)cm->cm_req;
934 	bzero(mpi_request,sizeof(MPI2_SATA_PASSTHROUGH_REQUEST));
935 	mpi_request->Function = MPI2_FUNCTION_SATA_PASSTHROUGH;
936 	mpi_request->VF_ID = 0;
937 	mpi_request->DevHandle = htole16(handle);
938 	mpi_request->PassthroughFlags = (MPI2_SATA_PT_REQ_PT_FLAGS_PIO |
939 	    MPI2_SATA_PT_REQ_PT_FLAGS_READ);
940 	mpi_request->DataLength = htole32(sz);
941 	mpi_request->CommandFIS[0] = 0x27;
942 	mpi_request->CommandFIS[1] = 0x80;
943 	mpi_request->CommandFIS[2] =  (devinfo &
944 	    MPI2_SAS_DEVICE_INFO_ATAPI_DEVICE) ? 0xA1 : 0xEC;
945 	cm->cm_sge = &mpi_request->SGL;
946 	cm->cm_sglsize = sizeof(MPI2_SGE_IO_UNION);
947 	cm->cm_flags = MPS_CM_FLAGS_SGE_SIMPLE | MPS_CM_FLAGS_DATAIN;
948 	cm->cm_desc.Default.RequestFlags = MPI2_REQ_DESCRIPT_FLAGS_DEFAULT_TYPE;
949 	cm->cm_data = buffer;
950 	cm->cm_length = htole32(sz);
951 
952 	/*
953 	 * Start a timeout counter specifically for the SATA ID command. This
954 	 * is used to fix a problem where the FW does not send a reply sometimes
955 	 * when a bad disk is in the topology. So, this is used to timeout the
956 	 * command so that processing can continue normally.
957 	 */
958 	mps_dprint(sc, MPS_XINFO, "%s start timeout counter for SATA ID "
959 	    "command\n", __func__);
960 	callout_reset(&cm->cm_callout, MPS_ATA_ID_TIMEOUT * hz,
961 	    mpssas_ata_id_timeout, cm);
962 	error = mps_wait_command(sc, &cm, 60, CAN_SLEEP);
963 	mps_dprint(sc, MPS_XINFO, "%s stop timeout counter for SATA ID "
964 	    "command\n", __func__);
965 	/* XXX KDM need to fix the case where this command is destroyed */
966 	callout_stop(&cm->cm_callout);
967 
968 	if (cm != NULL)
969 		reply = (Mpi2SataPassthroughReply_t *)cm->cm_reply;
970 	if (error || (reply == NULL)) {
971 		/* FIXME */
972  		/*
973  		 * If the request returns an error then we need to do a diag
974  		 * reset
975  		 */
976  		printf("%s: request for page completed with error %d",
977 		    __func__, error);
978 		error = ENXIO;
979 		goto out;
980 	}
981 	bcopy(buffer, id_buffer, sz);
982 	bcopy(reply, mpi_reply, sizeof(Mpi2SataPassthroughReply_t));
983 	if ((le16toh(reply->IOCStatus) & MPI2_IOCSTATUS_MASK) !=
984 	    MPI2_IOCSTATUS_SUCCESS) {
985 		printf("%s: error reading SATA PASSTHRU; iocstatus = 0x%x\n",
986 		    __func__, reply->IOCStatus);
987 		error = ENXIO;
988 		goto out;
989 	}
990 out:
991 	/*
992 	 * If the SATA_ID_TIMEOUT flag has been set for this command, don't free
993 	 * it.  The command will be freed after sending a target reset TM. If
994 	 * the command did timeout, use EWOULDBLOCK.
995 	 */
996 	if ((cm != NULL)
997 	 && (cm->cm_flags & MPS_CM_FLAGS_SATA_ID_TIMEOUT) == 0)
998 		mps_free_command(sc, cm);
999 	else if (error == 0)
1000 		error = EWOULDBLOCK;
1001 	free(buffer, M_MPT2);
1002 	return (error);
1003 }
1004 
1005 static void
1006 mpssas_ata_id_timeout(void *data)
1007 {
1008 	struct mps_softc *sc;
1009 	struct mps_command *cm;
1010 
1011 	cm = (struct mps_command *)data;
1012 	sc = cm->cm_sc;
1013 	mtx_assert(&sc->mps_mtx, MA_OWNED);
1014 
1015 	mps_dprint(sc, MPS_INFO, "%s checking ATA ID command %p sc %p\n",
1016 	    __func__, cm, sc);
1017 	if ((callout_pending(&cm->cm_callout)) ||
1018 	    (!callout_active(&cm->cm_callout))) {
1019 		mps_dprint(sc, MPS_INFO, "%s ATA ID command almost timed out\n",
1020 		    __func__);
1021 		return;
1022 	}
1023 	callout_deactivate(&cm->cm_callout);
1024 
1025 	/*
1026 	 * Run the interrupt handler to make sure it's not pending.  This
1027 	 * isn't perfect because the command could have already completed
1028 	 * and been re-used, though this is unlikely.
1029 	 */
1030 	mps_intr_locked(sc);
1031 	if (cm->cm_state == MPS_CM_STATE_FREE) {
1032 		mps_dprint(sc, MPS_INFO, "%s ATA ID command almost timed out\n",
1033 		    __func__);
1034 		return;
1035 	}
1036 
1037 	mps_dprint(sc, MPS_INFO, "ATA ID command timeout cm %p\n", cm);
1038 
1039 	/*
1040 	 * Send wakeup() to the sleeping thread that issued this ATA ID command.
1041 	 * wakeup() will cause msleep to return a 0 (not EWOULDBLOCK), and this
1042 	 * will keep reinit() from being called. This way, an Abort Task TM can
1043 	 * be issued so that the timed out command can be cleared.  The Abort
1044 	 * Task cannot be sent from here because the driver has not completed
1045 	 * setting up targets.  Instead, the command is flagged so that special
1046 	 * handling will be used to send the abort.
1047 	 */
1048 	cm->cm_flags |= MPS_CM_FLAGS_SATA_ID_TIMEOUT;
1049 	wakeup(cm);
1050 }
1051 
1052 static int
1053 mpssas_volume_add(struct mps_softc *sc, u16 handle)
1054 {
1055 	struct mpssas_softc *sassc;
1056 	struct mpssas_target *targ;
1057 	u64 wwid;
1058 	unsigned int id;
1059 	int error = 0;
1060 	struct mpssas_lun *lun;
1061 
1062 	sassc = sc->sassc;
1063 	mpssas_startup_increment(sassc);
1064 	/* wwid is endian safe */
1065 	mps_config_get_volume_wwid(sc, handle, &wwid);
1066 	if (!wwid) {
1067 		printf("%s: invalid WWID; cannot add volume to mapping table\n",
1068 		    __func__);
1069 		error = ENXIO;
1070 		goto out;
1071 	}
1072 
1073 	id = mps_mapping_get_raid_tid(sc, wwid, handle);
1074 	if (id == MPS_MAP_BAD_ID) {
1075 		printf("%s: could not get ID for volume with handle 0x%04x and "
1076 		    "WWID 0x%016llx\n", __func__, handle,
1077 		    (unsigned long long)wwid);
1078 		error = ENXIO;
1079 		goto out;
1080 	}
1081 
1082 	targ = &sassc->targets[id];
1083 	targ->tid = id;
1084 	targ->handle = handle;
1085 	targ->devname = wwid;
1086 	TAILQ_INIT(&targ->commands);
1087 	TAILQ_INIT(&targ->timedout_commands);
1088 	while(!SLIST_EMPTY(&targ->luns)) {
1089 		lun = SLIST_FIRST(&targ->luns);
1090 		SLIST_REMOVE_HEAD(&targ->luns, lun_link);
1091 		free(lun, M_MPT2);
1092 	}
1093 	SLIST_INIT(&targ->luns);
1094 #if __FreeBSD_version < 1000039
1095 	if ((sassc->flags & MPSSAS_IN_STARTUP) == 0)
1096 #endif
1097 		mpssas_rescan_target(sc, targ);
1098 	mps_dprint(sc, MPS_MAPPING, "RAID target id %d added (WWID = 0x%jx)\n",
1099 	    targ->tid, wwid);
1100 out:
1101 	mpssas_startup_decrement(sassc);
1102 	return (error);
1103 }
1104 
1105 /**
1106  * mpssas_SSU_to_SATA_devices
1107  * @sc: per adapter object
1108  *
1109  * Looks through the target list and issues a StartStopUnit SCSI command to each
1110  * SATA direct-access device.  This helps to ensure that data corruption is
1111  * avoided when the system is being shut down.  This must be called after the IR
1112  * System Shutdown RAID Action is sent if in IR mode.
1113  *
1114  * Return nothing.
1115  */
1116 static void
1117 mpssas_SSU_to_SATA_devices(struct mps_softc *sc)
1118 {
1119 	struct mpssas_softc *sassc = sc->sassc;
1120 	union ccb *ccb;
1121 	path_id_t pathid = cam_sim_path(sassc->sim);
1122 	target_id_t targetid;
1123 	struct mpssas_target *target;
1124 	char path_str[64];
1125 	struct timeval cur_time, start_time;
1126 
1127 	/*
1128 	 * For each target, issue a StartStopUnit command to stop the device.
1129 	 */
1130 	sc->SSU_started = TRUE;
1131 	sc->SSU_refcount = 0;
1132 	for (targetid = 0; targetid < sc->max_devices; targetid++) {
1133 		target = &sassc->targets[targetid];
1134 		if (target->handle == 0x0) {
1135 			continue;
1136 		}
1137 
1138 		ccb = xpt_alloc_ccb_nowait();
1139 		if (ccb == NULL) {
1140 			mps_dprint(sc, MPS_FAULT, "Unable to alloc CCB to stop "
1141 			    "unit.\n");
1142 			return;
1143 		}
1144 
1145 		/*
1146 		 * The stop_at_shutdown flag will be set if this device is
1147 		 * a SATA direct-access end device.
1148 		 */
1149 		if (target->stop_at_shutdown) {
1150 			if (xpt_create_path(&ccb->ccb_h.path,
1151 			    xpt_periph, pathid, targetid,
1152 			    CAM_LUN_WILDCARD) != CAM_REQ_CMP) {
1153 				mps_dprint(sc, MPS_FAULT, "Unable to create "
1154 				    "LUN path to stop unit.\n");
1155 				xpt_free_ccb(ccb);
1156 				return;
1157 			}
1158 			xpt_path_string(ccb->ccb_h.path, path_str,
1159 			    sizeof(path_str));
1160 
1161 			mps_dprint(sc, MPS_INFO, "Sending StopUnit: path %s "
1162 			    "handle %d\n", path_str, target->handle);
1163 
1164 			/*
1165 			 * Issue a START STOP UNIT command for the target.
1166 			 * Increment the SSU counter to be used to count the
1167 			 * number of required replies.
1168 			 */
1169 			mps_dprint(sc, MPS_INFO, "Incrementing SSU count\n");
1170 			sc->SSU_refcount++;
1171 			ccb->ccb_h.target_id =
1172 			    xpt_path_target_id(ccb->ccb_h.path);
1173 			ccb->ccb_h.ppriv_ptr1 = sassc;
1174 			scsi_start_stop(&ccb->csio,
1175 			    /*retries*/0,
1176 			    mpssas_stop_unit_done,
1177 			    MSG_SIMPLE_Q_TAG,
1178 			    /*start*/FALSE,
1179 			    /*load/eject*/0,
1180 			    /*immediate*/FALSE,
1181 			    MPS_SENSE_LEN,
1182 			    /*timeout*/10000);
1183 			xpt_action(ccb);
1184 		}
1185 	}
1186 
1187 	/*
1188 	 * Wait until all of the SSU commands have completed or time has
1189 	 * expired (60 seconds).  Pause for 100ms each time through.  If any
1190 	 * command times out, the target will be reset in the SCSI command
1191 	 * timeout routine.
1192 	 */
1193 	getmicrotime(&start_time);
1194 	while (sc->SSU_refcount) {
1195 		pause("mpswait", hz/10);
1196 
1197 		getmicrotime(&cur_time);
1198 		if ((cur_time.tv_sec - start_time.tv_sec) > 60) {
1199 			mps_dprint(sc, MPS_FAULT, "Time has expired waiting "
1200 			    "for SSU commands to complete.\n");
1201 			break;
1202 		}
1203 	}
1204 }
1205 
1206 static void
1207 mpssas_stop_unit_done(struct cam_periph *periph, union ccb *done_ccb)
1208 {
1209 	struct mpssas_softc *sassc;
1210 	char path_str[64];
1211 
1212 	if (done_ccb == NULL)
1213 		return;
1214 
1215 	sassc = (struct mpssas_softc *)done_ccb->ccb_h.ppriv_ptr1;
1216 
1217 	xpt_path_string(done_ccb->ccb_h.path, path_str, sizeof(path_str));
1218 	mps_dprint(sassc->sc, MPS_INFO, "Completing stop unit for %s\n",
1219 	    path_str);
1220 
1221 	/*
1222 	 * Nothing more to do except free the CCB and path.  If the command
1223 	 * timed out, an abort reset, then target reset will be issued during
1224 	 * the SCSI Command process.
1225 	 */
1226 	xpt_free_path(done_ccb->ccb_h.path);
1227 	xpt_free_ccb(done_ccb);
1228 }
1229 
1230 /**
1231  * mpssas_ir_shutdown - IR shutdown notification
1232  * @sc: per adapter object
1233  *
1234  * Sending RAID Action to alert the Integrated RAID subsystem of the IOC that
1235  * the host system is shutting down.
1236  *
1237  * Return nothing.
1238  */
1239 void
1240 mpssas_ir_shutdown(struct mps_softc *sc)
1241 {
1242 	u16 volume_mapping_flags;
1243 	u16 ioc_pg8_flags = le16toh(sc->ioc_pg8.Flags);
1244 	struct dev_mapping_table *mt_entry;
1245 	u32 start_idx, end_idx;
1246 	unsigned int id, found_volume = 0;
1247 	struct mps_command *cm;
1248 	Mpi2RaidActionRequest_t	*action;
1249 	target_id_t targetid;
1250 	struct mpssas_target *target;
1251 
1252 	mps_dprint(sc, MPS_TRACE, "%s\n", __func__);
1253 
1254 	/* is IR firmware build loaded? */
1255 	if (!sc->ir_firmware)
1256 		goto out;
1257 
1258 	/* are there any volumes?  Look at IR target IDs. */
1259 	// TODO-later, this should be looked up in the RAID config structure
1260 	// when it is implemented.
1261 	volume_mapping_flags = le16toh(sc->ioc_pg8.IRVolumeMappingFlags) &
1262 	    MPI2_IOCPAGE8_IRFLAGS_MASK_VOLUME_MAPPING_MODE;
1263 	if (volume_mapping_flags == MPI2_IOCPAGE8_IRFLAGS_LOW_VOLUME_MAPPING) {
1264 		start_idx = 0;
1265 		if (ioc_pg8_flags & MPI2_IOCPAGE8_FLAGS_RESERVED_TARGETID_0)
1266 			start_idx = 1;
1267 	} else
1268 		start_idx = sc->max_devices - sc->max_volumes;
1269 	end_idx = start_idx + sc->max_volumes - 1;
1270 
1271 	for (id = start_idx; id < end_idx; id++) {
1272 		mt_entry = &sc->mapping_table[id];
1273 		if ((mt_entry->physical_id != 0) &&
1274 		    (mt_entry->missing_count == 0)) {
1275 			found_volume = 1;
1276 			break;
1277 		}
1278 	}
1279 
1280 	if (!found_volume)
1281 		goto out;
1282 
1283 	if ((cm = mps_alloc_command(sc)) == NULL) {
1284 		printf("%s: command alloc failed\n", __func__);
1285 		goto out;
1286 	}
1287 
1288 	action = (MPI2_RAID_ACTION_REQUEST *)cm->cm_req;
1289 	action->Function = MPI2_FUNCTION_RAID_ACTION;
1290 	action->Action = MPI2_RAID_ACTION_SYSTEM_SHUTDOWN_INITIATED;
1291 	cm->cm_desc.Default.RequestFlags = MPI2_REQ_DESCRIPT_FLAGS_DEFAULT_TYPE;
1292 	mps_lock(sc);
1293 	mps_wait_command(sc, &cm, 5, CAN_SLEEP);
1294 	mps_unlock(sc);
1295 
1296 	/*
1297 	 * Don't check for reply, just leave.
1298 	 */
1299 	if (cm)
1300 		mps_free_command(sc, cm);
1301 
1302 out:
1303 	/*
1304 	 * All of the targets must have the correct value set for
1305 	 * 'stop_at_shutdown' for the current 'enable_ssu' sysctl variable.
1306 	 *
1307 	 * The possible values for the 'enable_ssu' variable are:
1308 	 * 0: disable to SSD and HDD
1309 	 * 1: disable only to HDD (default)
1310 	 * 2: disable only to SSD
1311 	 * 3: enable to SSD and HDD
1312 	 * anything else will default to 1.
1313 	 */
1314 	for (targetid = 0; targetid < sc->max_devices; targetid++) {
1315 		target = &sc->sassc->targets[targetid];
1316 		if (target->handle == 0x0) {
1317 			continue;
1318 		}
1319 
1320 		if (target->supports_SSU) {
1321 			switch (sc->enable_ssu) {
1322 			case MPS_SSU_DISABLE_SSD_DISABLE_HDD:
1323 				target->stop_at_shutdown = FALSE;
1324 				break;
1325 			case MPS_SSU_DISABLE_SSD_ENABLE_HDD:
1326 				target->stop_at_shutdown = TRUE;
1327 				if (target->flags & MPS_TARGET_IS_SATA_SSD) {
1328 					target->stop_at_shutdown = FALSE;
1329 				}
1330 				break;
1331 			case MPS_SSU_ENABLE_SSD_ENABLE_HDD:
1332 				target->stop_at_shutdown = TRUE;
1333 				break;
1334 			case MPS_SSU_ENABLE_SSD_DISABLE_HDD:
1335 			default:
1336 				target->stop_at_shutdown = TRUE;
1337 				if ((target->flags &
1338 				    MPS_TARGET_IS_SATA_SSD) == 0) {
1339 					target->stop_at_shutdown = FALSE;
1340 				}
1341 				break;
1342 			}
1343 		}
1344 	}
1345 	mpssas_SSU_to_SATA_devices(sc);
1346 }
1347