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