mpr_sas_lsi.c revision 299265
1/*-
2 * Copyright (c) 2011-2015 LSI Corp.
3 * Copyright (c) 2013-2016 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: head/sys/dev/mpr/mpr_sas_lsi.c 299265 2016-05-09 16:16:00Z slm $");
32
33/* Communications core for Avago Technologies (LSI) MPT3 */
34
35/* TODO Move headers to mprvar */
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/mpr/mpi/mpi2_type.h>
71#include <dev/mpr/mpi/mpi2.h>
72#include <dev/mpr/mpi/mpi2_ioc.h>
73#include <dev/mpr/mpi/mpi2_sas.h>
74#include <dev/mpr/mpi/mpi2_cnfg.h>
75#include <dev/mpr/mpi/mpi2_init.h>
76#include <dev/mpr/mpi/mpi2_raid.h>
77#include <dev/mpr/mpi/mpi2_tool.h>
78#include <dev/mpr/mpr_ioctl.h>
79#include <dev/mpr/mprvar.h>
80#include <dev/mpr/mpr_table.h>
81#include <dev/mpr/mpr_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
87struct mpr_fw_event_work {
88	u16			event;
89	void			*event_data;
90	TAILQ_ENTRY(mpr_fw_event_work)	ev_link;
91};
92
93union _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 */
104struct _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};
113static u32 event_count;
114static void mprsas_fw_work(struct mpr_softc *sc,
115    struct mpr_fw_event_work *fw_event);
116static void mprsas_fw_event_free(struct mpr_softc *,
117    struct mpr_fw_event_work *);
118static int mprsas_add_device(struct mpr_softc *sc, u16 handle, u8 linkrate);
119static int mprsas_get_sata_identify(struct mpr_softc *sc, u16 handle,
120    Mpi2SataPassthroughReply_t *mpi_reply, char *id_buffer, int sz,
121    u32 devinfo);
122static void mprsas_ata_id_timeout(void *data);
123int mprsas_get_sas_address_for_sata_disk(struct mpr_softc *sc,
124    u64 *sas_address, u16 handle, u32 device_info, u8 *is_SATA_SSD);
125static int mprsas_volume_add(struct mpr_softc *sc,
126    u16 handle);
127static void mprsas_SSU_to_SATA_devices(struct mpr_softc *sc);
128static void mprsas_stop_unit_done(struct cam_periph *periph,
129    union ccb *done_ccb);
130
131void
132mprsas_evt_handler(struct mpr_softc *sc, uintptr_t data,
133    MPI2_EVENT_NOTIFICATION_REPLY *event)
134{
135	struct mpr_fw_event_work *fw_event;
136	u16 sz;
137
138	mpr_dprint(sc, MPR_TRACE, "%s\n", __func__);
139	mpr_print_evt_sas(sc, event);
140	mprsas_record_event(sc, event);
141
142	fw_event = malloc(sizeof(struct mpr_fw_event_work), M_MPR,
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_MPR, 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_MPR);
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		mprsas_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
179static void
180mprsas_fw_event_free(struct mpr_softc *sc, struct mpr_fw_event_work *fw_event)
181{
182
183	free(fw_event->event_data, M_MPR);
184	free(fw_event, M_MPR);
185}
186
187/**
188 * _mpr_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 */
195static void
196mprsas_fw_work(struct mpr_softc *sc, struct mpr_fw_event_work *fw_event)
197{
198	struct mprsas_softc *sassc;
199	sassc = sc->sassc;
200
201	mpr_dprint(sc, MPR_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		mpr_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 (mprsas_add_device(sc,
220				    le16toh(phy->AttachedDevHandle),
221				    phy->LinkRate)) {
222					printf("%s: failed to add device with "
223					    "handle 0x%x\n", __func__,
224					    le16toh(phy->AttachedDevHandle));
225					mprsas_prepare_remove(sassc, le16toh(
226					    phy->AttachedDevHandle));
227				}
228				break;
229			case MPI2_EVENT_SAS_TOPO_RC_TARG_NOT_RESPONDING:
230				mprsas_prepare_remove(sassc, le16toh(
231				    phy->AttachedDevHandle));
232				break;
233			case MPI2_EVENT_SAS_TOPO_RC_PHY_CHANGED:
234			case MPI2_EVENT_SAS_TOPO_RC_NO_CHANGE:
235			case MPI2_EVENT_SAS_TOPO_RC_DELAY_NOT_RESPONDING:
236			default:
237				break;
238			}
239		}
240		/*
241		 * refcount was incremented for this event in
242		 * mprsas_evt_handler.  Decrement it here because the event has
243		 * been processed.
244		 */
245		mprsas_startup_decrement(sassc);
246		break;
247	}
248	case MPI2_EVENT_SAS_DISCOVERY:
249	{
250		MPI2_EVENT_DATA_SAS_DISCOVERY *data;
251
252		data = (MPI2_EVENT_DATA_SAS_DISCOVERY *)fw_event->event_data;
253
254		if (data->ReasonCode & MPI2_EVENT_SAS_DISC_RC_STARTED)
255			mpr_dprint(sc, MPR_TRACE,"SAS discovery start event\n");
256		if (data->ReasonCode & MPI2_EVENT_SAS_DISC_RC_COMPLETED) {
257			mpr_dprint(sc, MPR_TRACE,"SAS discovery stop event\n");
258			sassc->flags &= ~MPRSAS_IN_DISCOVERY;
259			mprsas_discovery_end(sassc);
260		}
261		break;
262	}
263	case MPI2_EVENT_SAS_ENCL_DEVICE_STATUS_CHANGE:
264	{
265		Mpi2EventDataSasEnclDevStatusChange_t *data;
266		data = (Mpi2EventDataSasEnclDevStatusChange_t *)
267		    fw_event->event_data;
268		mpr_mapping_enclosure_dev_status_change_event(sc,
269		    fw_event->event_data);
270		break;
271	}
272	case MPI2_EVENT_IR_CONFIGURATION_CHANGE_LIST:
273	{
274		Mpi2EventIrConfigElement_t *element;
275		int i;
276		u8 foreign_config, reason;
277		u16 elementType;
278		Mpi2EventDataIrConfigChangeList_t *event_data;
279		struct mprsas_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 = mpr_mapping_get_raid_id_from_handle(sc,
289		    element->VolDevHandle);
290
291		mpr_mapping_ir_config_change_event(sc, event_data);
292		for (i = 0; i < event_data->NumElements; i++, element++) {
293			reason = element->ReasonCode;
294			elementType = le16toh(element->ElementFlags) &
295			    MPI2_EVENT_IR_CHANGE_EFLAGS_ELEMENT_TYPE_MASK;
296			/*
297			 * check for element type of Phys Disk or Hot Spare
298			 */
299			if ((elementType !=
300			    MPI2_EVENT_IR_CHANGE_EFLAGS_VOLPHYSDISK_ELEMENT)
301			    && (elementType !=
302			    MPI2_EVENT_IR_CHANGE_EFLAGS_HOTSPARE_ELEMENT))
303				// do next element
304				goto skip_fp_send;
305
306			/*
307			 * check for reason of Hide, Unhide, PD Created, or PD
308			 * Deleted
309			 */
310			if ((reason != MPI2_EVENT_IR_CHANGE_RC_HIDE) &&
311			    (reason != MPI2_EVENT_IR_CHANGE_RC_UNHIDE) &&
312			    (reason != MPI2_EVENT_IR_CHANGE_RC_PD_CREATED) &&
313			    (reason != MPI2_EVENT_IR_CHANGE_RC_PD_DELETED))
314				goto skip_fp_send;
315
316			// check for a reason of Hide or PD Created
317			if ((reason == MPI2_EVENT_IR_CHANGE_RC_HIDE) ||
318			    (reason == MPI2_EVENT_IR_CHANGE_RC_PD_CREATED))
319			{
320				// build RAID Action message
321				Mpi2RaidActionRequest_t	*action;
322				Mpi2RaidActionReply_t *reply;
323				struct mpr_command *cm;
324				int error = 0;
325				if ((cm = mpr_alloc_command(sc)) == NULL) {
326					printf("%s: command alloc failed\n",
327					    __func__);
328					return;
329				}
330
331				mpr_dprint(sc, MPR_EVENT, "Sending FP action "
332				    "from "
333				    "MPI2_EVENT_IR_CONFIGURATION_CHANGE_LIST "
334				    ":\n");
335				action = (MPI2_RAID_ACTION_REQUEST *)cm->cm_req;
336				action->Function = MPI2_FUNCTION_RAID_ACTION;
337				action->Action =
338				    MPI2_RAID_ACTION_PHYSDISK_HIDDEN;
339				action->PhysDiskNum = element->PhysDiskNum;
340				cm->cm_desc.Default.RequestFlags =
341				    MPI2_REQ_DESCRIPT_FLAGS_DEFAULT_TYPE;
342				error = mpr_request_polled(sc, cm);
343				reply = (Mpi2RaidActionReply_t *)cm->cm_reply;
344				if (error || (reply == NULL)) {
345					/* FIXME */
346					/*
347					 * If the poll returns error then we
348					 * need to do diag reset
349					 */
350					printf("%s: poll for page completed "
351					    "with error %d", __func__, error);
352				}
353				if (reply && (le16toh(reply->IOCStatus) &
354				    MPI2_IOCSTATUS_MASK) !=
355				    MPI2_IOCSTATUS_SUCCESS) {
356					mpr_dprint(sc, MPR_ERROR, "%s: error "
357					    "sending RaidActionPage; "
358					    "iocstatus = 0x%x\n", __func__,
359					    le16toh(reply->IOCStatus));
360				}
361
362				if (cm)
363					mpr_free_command(sc, cm);
364			}
365skip_fp_send:
366			mpr_dprint(sc, MPR_EVENT, "Received "
367			    "MPI2_EVENT_IR_CONFIGURATION_CHANGE_LIST Reason "
368			    "code %x:\n", element->ReasonCode);
369			switch (element->ReasonCode) {
370			case MPI2_EVENT_IR_CHANGE_RC_VOLUME_CREATED:
371			case MPI2_EVENT_IR_CHANGE_RC_ADDED:
372				if (!foreign_config) {
373					if (mprsas_volume_add(sc,
374					    le16toh(element->VolDevHandle))) {
375						printf("%s: failed to add RAID "
376						    "volume with handle 0x%x\n",
377						    __func__, le16toh(element->
378						    VolDevHandle));
379					}
380				}
381				break;
382			case MPI2_EVENT_IR_CHANGE_RC_VOLUME_DELETED:
383			case MPI2_EVENT_IR_CHANGE_RC_REMOVED:
384				/*
385				 * Rescan after volume is deleted or removed.
386				 */
387				if (!foreign_config) {
388					if (id == MPR_MAP_BAD_ID) {
389						printf("%s: could not get ID "
390						    "for volume with handle "
391						    "0x%04x\n", __func__,
392						    le16toh(element->
393						    VolDevHandle));
394						break;
395					}
396
397					targ = &sassc->targets[id];
398					targ->handle = 0x0;
399					targ->encl_slot = 0x0;
400					targ->encl_handle = 0x0;
401					targ->encl_level_valid = 0x0;
402					targ->encl_level = 0x0;
403					targ->connector_name[0] = ' ';
404					targ->connector_name[1] = ' ';
405					targ->connector_name[2] = ' ';
406					targ->connector_name[3] = ' ';
407					targ->exp_dev_handle = 0x0;
408					targ->phy_num = 0x0;
409					targ->linkrate = 0x0;
410					mprsas_rescan_target(sc, targ);
411					printf("RAID target id 0x%x removed\n",
412					    targ->tid);
413				}
414				break;
415			case MPI2_EVENT_IR_CHANGE_RC_PD_CREATED:
416			case MPI2_EVENT_IR_CHANGE_RC_HIDE:
417				/*
418				 * Phys Disk of a volume has been created.  Hide
419				 * it from the OS.
420				 */
421				targ = mprsas_find_target_by_handle(sassc, 0,
422				    element->PhysDiskDevHandle);
423				if (targ == NULL)
424					break;
425				targ->flags |= MPR_TARGET_FLAGS_RAID_COMPONENT;
426				mprsas_rescan_target(sc, targ);
427				break;
428			case MPI2_EVENT_IR_CHANGE_RC_PD_DELETED:
429				/*
430				 * Phys Disk of a volume has been deleted.
431				 * Expose it to the OS.
432				 */
433				if (mprsas_add_device(sc,
434				    le16toh(element->PhysDiskDevHandle), 0)) {
435					printf("%s: failed to add device with "
436					    "handle 0x%x\n", __func__,
437					    le16toh(element->
438					    PhysDiskDevHandle));
439					mprsas_prepare_remove(sassc,
440					    le16toh(element->
441					    PhysDiskDevHandle));
442				}
443				break;
444			}
445		}
446		/*
447		 * refcount was incremented for this event in
448		 * mprsas_evt_handler.  Decrement it here because the event has
449		 * been processed.
450		 */
451		mprsas_startup_decrement(sassc);
452		break;
453	}
454	case MPI2_EVENT_IR_VOLUME:
455	{
456		Mpi2EventDataIrVolume_t *event_data = fw_event->event_data;
457
458		/*
459		 * Informational only.
460		 */
461		mpr_dprint(sc, MPR_EVENT, "Received IR Volume event:\n");
462		switch (event_data->ReasonCode) {
463		case MPI2_EVENT_IR_VOLUME_RC_SETTINGS_CHANGED:
464  			mpr_dprint(sc, MPR_EVENT, "   Volume Settings "
465  			    "changed from 0x%x to 0x%x for Volome with "
466 			    "handle 0x%x", le32toh(event_data->PreviousValue),
467 			    le32toh(event_data->NewValue),
468 			    le16toh(event_data->VolDevHandle));
469			break;
470		case MPI2_EVENT_IR_VOLUME_RC_STATUS_FLAGS_CHANGED:
471  			mpr_dprint(sc, MPR_EVENT, "   Volume Status "
472  			    "changed from 0x%x to 0x%x for Volome with "
473 			    "handle 0x%x", le32toh(event_data->PreviousValue),
474 			    le32toh(event_data->NewValue),
475 			    le16toh(event_data->VolDevHandle));
476			break;
477		case MPI2_EVENT_IR_VOLUME_RC_STATE_CHANGED:
478  			mpr_dprint(sc, MPR_EVENT, "   Volume State "
479  			    "changed from 0x%x to 0x%x for Volome with "
480 			    "handle 0x%x", le32toh(event_data->PreviousValue),
481 			    le32toh(event_data->NewValue),
482 			    le16toh(event_data->VolDevHandle));
483				u32 state;
484				struct mprsas_target *targ;
485				state = le32toh(event_data->NewValue);
486				switch (state) {
487				case MPI2_RAID_VOL_STATE_MISSING:
488				case MPI2_RAID_VOL_STATE_FAILED:
489					mprsas_prepare_volume_remove(sassc,
490					    event_data->VolDevHandle);
491					break;
492
493				case MPI2_RAID_VOL_STATE_ONLINE:
494				case MPI2_RAID_VOL_STATE_DEGRADED:
495				case MPI2_RAID_VOL_STATE_OPTIMAL:
496					targ =
497					    mprsas_find_target_by_handle(sassc,
498					    0, event_data->VolDevHandle);
499					if (targ) {
500						printf("%s %d: Volume handle "
501						    "0x%x is already added \n",
502						    __func__, __LINE__,
503						    event_data->VolDevHandle);
504						break;
505					}
506					if (mprsas_volume_add(sc,
507					    le16toh(event_data->
508					    VolDevHandle))) {
509						printf("%s: failed to add RAID "
510						    "volume with handle 0x%x\n",
511						    __func__, le16toh(
512						    event_data->VolDevHandle));
513					}
514					break;
515				default:
516					break;
517				}
518			break;
519		default:
520			break;
521		}
522		break;
523	}
524	case MPI2_EVENT_IR_PHYSICAL_DISK:
525	{
526		Mpi2EventDataIrPhysicalDisk_t *event_data =
527		    fw_event->event_data;
528		struct mprsas_target *targ;
529
530		/*
531		 * Informational only.
532		 */
533		mpr_dprint(sc, MPR_EVENT, "Received IR Phys Disk event:\n");
534		switch (event_data->ReasonCode) {
535		case MPI2_EVENT_IR_PHYSDISK_RC_SETTINGS_CHANGED:
536  			mpr_dprint(sc, MPR_EVENT, "   Phys Disk Settings "
537  			    "changed from 0x%x to 0x%x for Phys Disk Number "
538  			    "%d and handle 0x%x at Enclosure handle 0x%x, Slot "
539 			    "%d", le32toh(event_data->PreviousValue),
540 			    le32toh(event_data->NewValue),
541			    event_data->PhysDiskNum,
542 			    le16toh(event_data->PhysDiskDevHandle),
543 			    le16toh(event_data->EnclosureHandle),
544			    le16toh(event_data->Slot));
545			break;
546		case MPI2_EVENT_IR_PHYSDISK_RC_STATUS_FLAGS_CHANGED:
547  			mpr_dprint(sc, MPR_EVENT, "   Phys Disk Status changed "
548  			    "from 0x%x to 0x%x for Phys Disk Number %d and "
549  			    "handle 0x%x at Enclosure handle 0x%x, Slot %d",
550 			    le32toh(event_data->PreviousValue),
551 			    le32toh(event_data->NewValue),
552			    event_data->PhysDiskNum,
553 			    le16toh(event_data->PhysDiskDevHandle),
554 			    le16toh(event_data->EnclosureHandle),
555			    le16toh(event_data->Slot));
556			break;
557		case MPI2_EVENT_IR_PHYSDISK_RC_STATE_CHANGED:
558  			mpr_dprint(sc, MPR_EVENT, "   Phys Disk State changed "
559  			    "from 0x%x to 0x%x for Phys Disk Number %d and "
560  			    "handle 0x%x at Enclosure handle 0x%x, Slot %d",
561 			    le32toh(event_data->PreviousValue),
562 			    le32toh(event_data->NewValue),
563			    event_data->PhysDiskNum,
564 			    le16toh(event_data->PhysDiskDevHandle),
565 			    le16toh(event_data->EnclosureHandle),
566			    le16toh(event_data->Slot));
567			switch (event_data->NewValue) {
568				case MPI2_RAID_PD_STATE_ONLINE:
569				case MPI2_RAID_PD_STATE_DEGRADED:
570				case MPI2_RAID_PD_STATE_REBUILDING:
571				case MPI2_RAID_PD_STATE_OPTIMAL:
572				case MPI2_RAID_PD_STATE_HOT_SPARE:
573					targ = mprsas_find_target_by_handle(
574					    sassc, 0,
575					    event_data->PhysDiskDevHandle);
576					if (targ) {
577						targ->flags |=
578						    MPR_TARGET_FLAGS_RAID_COMPONENT;
579						printf("%s %d: Found Target "
580						    "for handle 0x%x.\n",
581						    __func__, __LINE__ ,
582						    event_data->
583						    PhysDiskDevHandle);
584					}
585				break;
586				case MPI2_RAID_PD_STATE_OFFLINE:
587				case MPI2_RAID_PD_STATE_NOT_CONFIGURED:
588				case MPI2_RAID_PD_STATE_NOT_COMPATIBLE:
589				default:
590					targ = mprsas_find_target_by_handle(
591					    sassc, 0,
592					    event_data->PhysDiskDevHandle);
593					if (targ) {
594						targ->flags |=
595					    ~MPR_TARGET_FLAGS_RAID_COMPONENT;
596						printf("%s %d: Found Target "
597						    "for handle 0x%x.  \n",
598						    __func__, __LINE__ ,
599						    event_data->
600						    PhysDiskDevHandle);
601					}
602				break;
603			}
604		default:
605			break;
606		}
607		break;
608	}
609	case MPI2_EVENT_IR_OPERATION_STATUS:
610	{
611		Mpi2EventDataIrOperationStatus_t *event_data =
612		    fw_event->event_data;
613
614		/*
615		 * Informational only.
616		 */
617		mpr_dprint(sc, MPR_EVENT, "Received IR Op Status event:\n");
618		mpr_dprint(sc, MPR_EVENT, "   RAID Operation of %d is %d "
619		    "percent complete for Volume with handle 0x%x",
620		    event_data->RAIDOperation, event_data->PercentComplete,
621		    le16toh(event_data->VolDevHandle));
622		break;
623	}
624	case MPI2_EVENT_TEMP_THRESHOLD:
625	{
626		pMpi2EventDataTemperature_t	temp_event;
627
628		temp_event = (pMpi2EventDataTemperature_t)fw_event->event_data;
629
630		/*
631		 * The Temp Sensor Count must be greater than the event's Sensor
632		 * Num to be valid.  If valid, print the temp thresholds that
633		 * have been exceeded.
634		 */
635		if (sc->iounit_pg8.NumSensors > temp_event->SensorNum) {
636			mpr_dprint(sc, MPR_FAULT, "Temperature Threshold flags "
637			    "%s %s %s %s exceeded for Sensor: %d !!!\n",
638			    ((temp_event->Status & 0x01) == 1) ? "0 " : " ",
639			    ((temp_event->Status & 0x02) == 2) ? "1 " : " ",
640			    ((temp_event->Status & 0x04) == 4) ? "2 " : " ",
641			    ((temp_event->Status & 0x08) == 8) ? "3 " : " ",
642			    temp_event->SensorNum);
643			mpr_dprint(sc, MPR_FAULT, "Current Temp in Celsius: "
644			    "%d\n", temp_event->CurrentTemperature);
645		}
646		break;
647	}
648	case MPI2_EVENT_SAS_DEVICE_STATUS_CHANGE:
649	case MPI2_EVENT_SAS_BROADCAST_PRIMITIVE:
650	default:
651		mpr_dprint(sc, MPR_TRACE,"Unhandled event 0x%0X\n",
652		    fw_event->event);
653		break;
654
655	}
656	mpr_dprint(sc, MPR_EVENT, "(%d)->(%s) Event Free: [%x]\n", event_count,
657	    __func__, fw_event->event);
658	mprsas_fw_event_free(sc, fw_event);
659}
660
661void
662mprsas_firmware_event_work(void *arg, int pending)
663{
664	struct mpr_fw_event_work *fw_event;
665	struct mpr_softc *sc;
666
667	sc = (struct mpr_softc *)arg;
668	mpr_lock(sc);
669	while ((fw_event = TAILQ_FIRST(&sc->sassc->ev_queue)) != NULL) {
670		TAILQ_REMOVE(&sc->sassc->ev_queue, fw_event, ev_link);
671		mprsas_fw_work(sc, fw_event);
672	}
673	mpr_unlock(sc);
674}
675
676static int
677mprsas_add_device(struct mpr_softc *sc, u16 handle, u8 linkrate){
678	char devstring[80];
679	struct mprsas_softc *sassc;
680	struct mprsas_target *targ;
681	Mpi2ConfigReply_t mpi_reply;
682	Mpi2SasDevicePage0_t config_page;
683	uint64_t sas_address, parent_sas_address = 0;
684	u32 device_info, parent_devinfo = 0;
685	unsigned int id;
686	int ret = 1, error = 0, i;
687	struct mprsas_lun *lun;
688	u8 is_SATA_SSD = 0;
689	struct mpr_command *cm;
690
691	sassc = sc->sassc;
692	mprsas_startup_increment(sassc);
693	if ((mpr_config_get_sas_device_pg0(sc, &mpi_reply, &config_page,
694	     MPI2_SAS_DEVICE_PGAD_FORM_HANDLE, handle))) {
695		printf("%s: error reading SAS device page0\n", __func__);
696		error = ENXIO;
697		goto out;
698	}
699
700	device_info = le32toh(config_page.DeviceInfo);
701
702	if (((device_info & MPI2_SAS_DEVICE_INFO_SMP_TARGET) == 0)
703	    && (le16toh(config_page.ParentDevHandle) != 0)) {
704		Mpi2ConfigReply_t tmp_mpi_reply;
705		Mpi2SasDevicePage0_t parent_config_page;
706
707		if ((mpr_config_get_sas_device_pg0(sc, &tmp_mpi_reply,
708		     &parent_config_page, MPI2_SAS_DEVICE_PGAD_FORM_HANDLE,
709		     le16toh(config_page.ParentDevHandle)))) {
710			printf("%s: error reading SAS device %#x page0\n",
711			    __func__, le16toh(config_page.ParentDevHandle));
712		} else {
713			parent_sas_address = parent_config_page.SASAddress.High;
714			parent_sas_address = (parent_sas_address << 32) |
715			    parent_config_page.SASAddress.Low;
716			parent_devinfo = le32toh(parent_config_page.DeviceInfo);
717		}
718	}
719	/* TODO Check proper endianness */
720	sas_address = config_page.SASAddress.High;
721	sas_address = (sas_address << 32) | config_page.SASAddress.Low;
722	mpr_dprint(sc, MPR_INFO, "SAS Address from SAS device page0 = %jx\n",
723	    sas_address);
724
725	/*
726	 * Always get SATA Identify information because this is used to
727	 * determine if Start/Stop Unit should be sent to the drive when the
728	 * system is shutdown.
729	 */
730	if (device_info & MPI2_SAS_DEVICE_INFO_SATA_DEVICE) {
731		ret = mprsas_get_sas_address_for_sata_disk(sc, &sas_address,
732		    handle, device_info, &is_SATA_SSD);
733		if (ret) {
734			mpr_dprint(sc, MPR_ERROR, "%s: failed to get disk type "
735			    "(SSD or HDD) for SATA device with handle 0x%04x\n",
736			    __func__, handle);
737		} else {
738			mpr_dprint(sc, MPR_INFO, "SAS Address from SATA "
739			    "device = %jx\n", sas_address);
740		}
741	}
742
743	id = mpr_mapping_get_sas_id(sc, sas_address, handle);
744	if (id == MPR_MAP_BAD_ID) {
745		printf("failure at %s:%d/%s()! Could not get ID for device "
746		    "with handle 0x%04x\n", __FILE__, __LINE__, __func__,
747		    handle);
748		error = ENXIO;
749		goto out;
750	}
751
752	if (mprsas_check_id(sassc, id) != 0) {
753		device_printf(sc->mpr_dev, "Excluding target id %d\n", id);
754		error = ENXIO;
755		goto out;
756	}
757
758	mpr_dprint(sc, MPR_MAPPING, "SAS Address from SAS device page0 = %jx\n",
759	    sas_address);
760	targ = &sassc->targets[id];
761	targ->devinfo = device_info;
762	targ->devname = le32toh(config_page.DeviceName.High);
763	targ->devname = (targ->devname << 32) |
764	    le32toh(config_page.DeviceName.Low);
765	targ->encl_handle = le16toh(config_page.EnclosureHandle);
766	targ->encl_slot = le16toh(config_page.Slot);
767	targ->encl_level = config_page.EnclosureLevel;
768	targ->connector_name[0] = config_page.ConnectorName[0];
769	targ->connector_name[1] = config_page.ConnectorName[1];
770	targ->connector_name[2] = config_page.ConnectorName[2];
771	targ->connector_name[3] = config_page.ConnectorName[3];
772	targ->handle = handle;
773	targ->parent_handle = le16toh(config_page.ParentDevHandle);
774	targ->sasaddr = mpr_to_u64(&config_page.SASAddress);
775	targ->parent_sasaddr = le64toh(parent_sas_address);
776	targ->parent_devinfo = parent_devinfo;
777	targ->tid = id;
778	targ->linkrate = (linkrate>>4);
779	targ->flags = 0;
780	if (is_SATA_SSD) {
781		targ->flags = MPR_TARGET_IS_SATA_SSD;
782	}
783	if (le16toh(config_page.Flags) &
784	    MPI25_SAS_DEVICE0_FLAGS_FAST_PATH_CAPABLE) {
785		targ->scsi_req_desc_type =
786		    MPI25_REQ_DESCRIPT_FLAGS_FAST_PATH_SCSI_IO;
787	}
788	if (le16toh(config_page.Flags) &
789	    MPI2_SAS_DEVICE0_FLAGS_ENCL_LEVEL_VALID) {
790		targ->encl_level_valid = TRUE;
791	}
792	TAILQ_INIT(&targ->commands);
793	TAILQ_INIT(&targ->timedout_commands);
794	while (!SLIST_EMPTY(&targ->luns)) {
795		lun = SLIST_FIRST(&targ->luns);
796		SLIST_REMOVE_HEAD(&targ->luns, lun_link);
797		free(lun, M_MPR);
798	}
799	SLIST_INIT(&targ->luns);
800
801	mpr_describe_devinfo(targ->devinfo, devstring, 80);
802	mpr_dprint(sc, (MPR_INFO|MPR_MAPPING), "Found device <%s> <%s> "
803	    "handle<0x%04x> enclosureHandle<0x%04x> slot %d\n", devstring,
804	    mpr_describe_table(mpr_linkrate_names, targ->linkrate),
805	    targ->handle, targ->encl_handle, targ->encl_slot);
806	if (targ->encl_level_valid) {
807		mpr_dprint(sc, (MPR_INFO|MPR_MAPPING), "At enclosure level %d "
808		    "and connector name (%4s)\n", targ->encl_level,
809		    targ->connector_name);
810	}
811#if ((__FreeBSD_version >= 1000000) && (__FreeBSD_version < 1000039)) || \
812    (__FreeBSD_version < 902502)
813	if ((sassc->flags & MPRSAS_IN_STARTUP) == 0)
814#endif
815		mprsas_rescan_target(sc, targ);
816	mpr_dprint(sc, MPR_MAPPING, "Target id 0x%x added\n", targ->tid);
817
818	/*
819	 * Check all commands to see if the SATA_ID_TIMEOUT flag has been set.
820	 * If so, send a Target Reset TM to the target that was just created.
821	 * An Abort Task TM should be used instead of a Target Reset, but that
822	 * would be much more difficult because targets have not been fully
823	 * discovered yet, and LUN's haven't been setup.  So, just reset the
824	 * target instead of the LUN.
825	 */
826	for (i = 1; i < sc->num_reqs; i++) {
827		cm = &sc->commands[i];
828		if (cm->cm_flags & MPR_CM_FLAGS_SATA_ID_TIMEOUT) {
829			targ->timeouts++;
830			cm->cm_state = MPR_CM_STATE_TIMEDOUT;
831
832			if ((targ->tm = mprsas_alloc_tm(sc)) != NULL) {
833				mpr_dprint(sc, MPR_INFO, "%s: sending Target "
834				    "Reset for stuck SATA identify command "
835				    "(cm = %p)\n", __func__, cm);
836				targ->tm->cm_targ = targ;
837				mprsas_send_reset(sc, targ->tm,
838				    MPI2_SCSITASKMGMT_TASKTYPE_TARGET_RESET);
839			} else {
840				mpr_dprint(sc, MPR_ERROR, "Failed to allocate "
841				    "tm for Target Reset after SATA ID command "
842				    "timed out (cm %p)\n", cm);
843			}
844			/*
845			 * No need to check for more since the target is
846			 * already being reset.
847			 */
848			break;
849		}
850	}
851out:
852	/*
853	 * Free the commands that may not have been freed from the SATA ID call
854	 */
855	for (i = 1; i < sc->num_reqs; i++) {
856		cm = &sc->commands[i];
857		if (cm->cm_flags & MPR_CM_FLAGS_SATA_ID_TIMEOUT) {
858			mpr_free_command(sc, cm);
859		}
860	}
861	mprsas_startup_decrement(sassc);
862	return (error);
863}
864
865int
866mprsas_get_sas_address_for_sata_disk(struct mpr_softc *sc,
867    u64 *sas_address, u16 handle, u32 device_info, u8 *is_SATA_SSD)
868{
869	Mpi2SataPassthroughReply_t mpi_reply;
870	int i, rc, try_count;
871	u32 *bufferptr;
872	union _sata_sas_address hash_address;
873	struct _ata_identify_device_data ata_identify;
874	u8 buffer[MPT2SAS_MN_LEN + MPT2SAS_SN_LEN];
875	u32 ioc_status;
876	u8 sas_status;
877
878	memset(&ata_identify, 0, sizeof(ata_identify));
879	try_count = 0;
880	do {
881		rc = mprsas_get_sata_identify(sc, handle, &mpi_reply,
882		    (char *)&ata_identify, sizeof(ata_identify), device_info);
883		try_count++;
884		ioc_status = le16toh(mpi_reply.IOCStatus)
885		    & MPI2_IOCSTATUS_MASK;
886		sas_status = mpi_reply.SASStatus;
887		switch (ioc_status) {
888		case MPI2_IOCSTATUS_SUCCESS:
889			break;
890		case MPI2_IOCSTATUS_SCSI_PROTOCOL_ERROR:
891			/* No sense sleeping.  this error won't get better */
892			break;
893		default:
894			if (sc->spinup_wait_time > 0) {
895				mpr_dprint(sc, MPR_INFO, "Sleeping %d seconds "
896				    "after SATA ID error to wait for spinup\n",
897				    sc->spinup_wait_time);
898				msleep(&sc->msleep_fake_chan, &sc->mpr_mtx, 0,
899				    "mprid", sc->spinup_wait_time * hz);
900			}
901		}
902	} while (((rc && (rc != EWOULDBLOCK)) ||
903	    (ioc_status && (ioc_status != MPI2_IOCSTATUS_SCSI_PROTOCOL_ERROR))
904	    || sas_status) && (try_count < 5));
905
906	if (rc == 0 && !ioc_status && !sas_status) {
907		mpr_dprint(sc, MPR_MAPPING, "%s: got SATA identify "
908		    "successfully for handle = 0x%x with try_count = %d\n",
909		    __func__, handle, try_count);
910	} else {
911		mpr_dprint(sc, MPR_MAPPING, "%s: handle = 0x%x failed\n",
912		    __func__, handle);
913		return -1;
914	}
915	/* Copy & byteswap the 40 byte model number to a buffer */
916	for (i = 0; i < MPT2SAS_MN_LEN; i += 2) {
917		buffer[i] = ((u8 *)ata_identify.model_number)[i + 1];
918		buffer[i + 1] = ((u8 *)ata_identify.model_number)[i];
919	}
920	/* Copy & byteswap the 20 byte serial number to a buffer */
921	for (i = 0; i < MPT2SAS_SN_LEN; i += 2) {
922		buffer[MPT2SAS_MN_LEN + i] =
923		    ((u8 *)ata_identify.serial_number)[i + 1];
924		buffer[MPT2SAS_MN_LEN + i + 1] =
925		    ((u8 *)ata_identify.serial_number)[i];
926	}
927	bufferptr = (u32 *)buffer;
928	/* There are 60 bytes to hash down to 8. 60 isn't divisible by 8,
929	 * so loop through the first 56 bytes (7*8),
930	 * and then add in the last dword.
931	 */
932	hash_address.word.low  = 0;
933	hash_address.word.high = 0;
934	for (i = 0; (i < ((MPT2SAS_MN_LEN+MPT2SAS_SN_LEN)/8)); i++) {
935		hash_address.word.low += *bufferptr;
936		bufferptr++;
937		hash_address.word.high += *bufferptr;
938		bufferptr++;
939	}
940	/* Add the last dword */
941	hash_address.word.low += *bufferptr;
942	/* Make sure the hash doesn't start with 5, because it could clash
943	 * with a SAS address. Change 5 to a D.
944	 */
945	if ((hash_address.word.high & 0x000000F0) == (0x00000050))
946		hash_address.word.high |= 0x00000080;
947	*sas_address = (u64)hash_address.wwid[0] << 56 |
948	    (u64)hash_address.wwid[1] << 48 | (u64)hash_address.wwid[2] << 40 |
949	    (u64)hash_address.wwid[3] << 32 | (u64)hash_address.wwid[4] << 24 |
950	    (u64)hash_address.wwid[5] << 16 | (u64)hash_address.wwid[6] <<  8 |
951	    (u64)hash_address.wwid[7];
952	if (ata_identify.rotational_speed == 1) {
953		*is_SATA_SSD = 1;
954	}
955
956	return 0;
957}
958
959static int
960mprsas_get_sata_identify(struct mpr_softc *sc, u16 handle,
961    Mpi2SataPassthroughReply_t *mpi_reply, char *id_buffer, int sz, u32 devinfo)
962{
963	Mpi2SataPassthroughRequest_t *mpi_request;
964	Mpi2SataPassthroughReply_t *reply;
965	struct mpr_command *cm;
966	char *buffer;
967	int error = 0;
968
969	buffer = malloc( sz, M_MPR, M_NOWAIT | M_ZERO);
970	if (!buffer)
971		return ENOMEM;
972
973	if ((cm = mpr_alloc_command(sc)) == NULL) {
974		free(buffer, M_MPR);
975		return (EBUSY);
976	}
977	mpi_request = (MPI2_SATA_PASSTHROUGH_REQUEST *)cm->cm_req;
978	bzero(mpi_request,sizeof(MPI2_SATA_PASSTHROUGH_REQUEST));
979	mpi_request->Function = MPI2_FUNCTION_SATA_PASSTHROUGH;
980	mpi_request->VF_ID = 0;
981	mpi_request->DevHandle = htole16(handle);
982	mpi_request->PassthroughFlags = (MPI2_SATA_PT_REQ_PT_FLAGS_PIO |
983	    MPI2_SATA_PT_REQ_PT_FLAGS_READ);
984	mpi_request->DataLength = htole32(sz);
985	mpi_request->CommandFIS[0] = 0x27;
986	mpi_request->CommandFIS[1] = 0x80;
987	mpi_request->CommandFIS[2] =  (devinfo &
988	    MPI2_SAS_DEVICE_INFO_ATAPI_DEVICE) ? 0xA1 : 0xEC;
989	cm->cm_sge = &mpi_request->SGL;
990	cm->cm_sglsize = sizeof(MPI2_SGE_IO_UNION);
991	cm->cm_flags = MPR_CM_FLAGS_DATAIN;
992	cm->cm_desc.Default.RequestFlags = MPI2_REQ_DESCRIPT_FLAGS_DEFAULT_TYPE;
993	cm->cm_data = buffer;
994	cm->cm_length = htole32(sz);
995
996	/*
997	 * Start a timeout counter specifically for the SATA ID command. This
998	 * is used to fix a problem where the FW does not send a reply sometimes
999	 * when a bad disk is in the topology. So, this is used to timeout the
1000	 * command so that processing can continue normally.
1001	 */
1002	mpr_dprint(sc, MPR_XINFO, "%s start timeout counter for SATA ID "
1003	    "command\n", __func__);
1004	callout_reset(&cm->cm_callout, MPR_ATA_ID_TIMEOUT * hz,
1005	    mprsas_ata_id_timeout, cm);
1006	error = mpr_wait_command(sc, cm, 60, CAN_SLEEP);
1007	mpr_dprint(sc, MPR_XINFO, "%s stop timeout counter for SATA ID "
1008	    "command\n", __func__);
1009	callout_stop(&cm->cm_callout);
1010
1011	reply = (Mpi2SataPassthroughReply_t *)cm->cm_reply;
1012	if (error || (reply == NULL)) {
1013		/* FIXME */
1014		/*
1015		 * If the request returns an error then we need to do a diag
1016		 * reset
1017		 */
1018		printf("%s: request for page completed with error %d",
1019		    __func__, error);
1020		error = ENXIO;
1021		goto out;
1022	}
1023	bcopy(buffer, id_buffer, sz);
1024	bcopy(reply, mpi_reply, sizeof(Mpi2SataPassthroughReply_t));
1025	if ((le16toh(reply->IOCStatus) & MPI2_IOCSTATUS_MASK) !=
1026	    MPI2_IOCSTATUS_SUCCESS) {
1027		printf("%s: error reading SATA PASSTHRU; iocstatus = 0x%x\n",
1028		    __func__, reply->IOCStatus);
1029		error = ENXIO;
1030		goto out;
1031	}
1032out:
1033	/*
1034	 * If the SATA_ID_TIMEOUT flag has been set for this command, don't free
1035	 * it.  The command will be freed after sending a target reset TM. If
1036	 * the command did timeout, use EWOULDBLOCK.
1037	 */
1038	if ((cm->cm_flags & MPR_CM_FLAGS_SATA_ID_TIMEOUT) == 0)
1039		mpr_free_command(sc, cm);
1040	else if (error == 0)
1041		error = EWOULDBLOCK;
1042	free(buffer, M_MPR);
1043	return (error);
1044}
1045
1046static void
1047mprsas_ata_id_timeout(void *data)
1048{
1049	struct mpr_softc *sc;
1050	struct mpr_command *cm;
1051
1052	cm = (struct mpr_command *)data;
1053	sc = cm->cm_sc;
1054	mtx_assert(&sc->mpr_mtx, MA_OWNED);
1055
1056	mpr_dprint(sc, MPR_INFO, "%s checking ATA ID command %p sc %p\n",
1057	    __func__, cm, sc);
1058	if ((callout_pending(&cm->cm_callout)) ||
1059	    (!callout_active(&cm->cm_callout))) {
1060		mpr_dprint(sc, MPR_INFO, "%s ATA ID command almost timed out\n",
1061		    __func__);
1062		return;
1063	}
1064	callout_deactivate(&cm->cm_callout);
1065
1066	/*
1067	 * Run the interrupt handler to make sure it's not pending.  This
1068	 * isn't perfect because the command could have already completed
1069	 * and been re-used, though this is unlikely.
1070	 */
1071	mpr_intr_locked(sc);
1072	if (cm->cm_state == MPR_CM_STATE_FREE) {
1073		mpr_dprint(sc, MPR_INFO, "%s ATA ID command almost timed out\n",
1074		    __func__);
1075		return;
1076	}
1077
1078	mpr_dprint(sc, MPR_INFO, "ATA ID command timeout cm %p\n", cm);
1079
1080	/*
1081	 * Send wakeup() to the sleeping thread that issued this ATA ID command.
1082	 * wakeup() will cause msleep to return a 0 (not EWOULDBLOCK), and this
1083	 * will keep reinit() from being called. This way, an Abort Task TM can
1084	 * be issued so that the timed out command can be cleared. The Abort
1085	 * Task cannot be sent from here because the driver has not completed
1086	 * setting up targets.  Instead, the command is flagged so that special
1087	 * handling will be used to send the abort.
1088	 */
1089	cm->cm_flags |= MPR_CM_FLAGS_SATA_ID_TIMEOUT;
1090	wakeup(cm);
1091}
1092
1093static int
1094mprsas_volume_add(struct mpr_softc *sc, u16 handle)
1095{
1096	struct mprsas_softc *sassc;
1097	struct mprsas_target *targ;
1098	u64 wwid;
1099	unsigned int id;
1100	int error = 0;
1101	struct mprsas_lun *lun;
1102
1103	sassc = sc->sassc;
1104	mprsas_startup_increment(sassc);
1105	/* wwid is endian safe */
1106	mpr_config_get_volume_wwid(sc, handle, &wwid);
1107	if (!wwid) {
1108		printf("%s: invalid WWID; cannot add volume to mapping table\n",
1109		    __func__);
1110		error = ENXIO;
1111		goto out;
1112	}
1113
1114	id = mpr_mapping_get_raid_id(sc, wwid, handle);
1115	if (id == MPR_MAP_BAD_ID) {
1116		printf("%s: could not get ID for volume with handle 0x%04x and "
1117		    "WWID 0x%016llx\n", __func__, handle,
1118		    (unsigned long long)wwid);
1119		error = ENXIO;
1120		goto out;
1121	}
1122
1123	targ = &sassc->targets[id];
1124	targ->tid = id;
1125	targ->handle = handle;
1126	targ->devname = wwid;
1127	TAILQ_INIT(&targ->commands);
1128	TAILQ_INIT(&targ->timedout_commands);
1129	while (!SLIST_EMPTY(&targ->luns)) {
1130		lun = SLIST_FIRST(&targ->luns);
1131		SLIST_REMOVE_HEAD(&targ->luns, lun_link);
1132		free(lun, M_MPR);
1133	}
1134	SLIST_INIT(&targ->luns);
1135#if ((__FreeBSD_version >= 1000000) && (__FreeBSD_version < 1000039)) || \
1136    (__FreeBSD_version < 902502)
1137	if ((sassc->flags & MPRSAS_IN_STARTUP) == 0)
1138#endif
1139		mprsas_rescan_target(sc, targ);
1140	mpr_dprint(sc, MPR_MAPPING, "RAID target id %d added (WWID = 0x%jx)\n",
1141	    targ->tid, wwid);
1142out:
1143	mprsas_startup_decrement(sassc);
1144	return (error);
1145}
1146
1147/**
1148 * mprsas_SSU_to_SATA_devices
1149 * @sc: per adapter object
1150 *
1151 * Looks through the target list and issues a StartStopUnit SCSI command to each
1152 * SATA direct-access device.  This helps to ensure that data corruption is
1153 * avoided when the system is being shut down.  This must be called after the IR
1154 * System Shutdown RAID Action is sent if in IR mode.
1155 *
1156 * Return nothing.
1157 */
1158static void
1159mprsas_SSU_to_SATA_devices(struct mpr_softc *sc)
1160{
1161	struct mprsas_softc *sassc = sc->sassc;
1162	union ccb *ccb;
1163	path_id_t pathid = cam_sim_path(sassc->sim);
1164	target_id_t targetid;
1165	struct mprsas_target *target;
1166	char path_str[64];
1167	struct timeval cur_time, start_time;
1168
1169	mpr_lock(sc);
1170
1171	/*
1172	 * For each target, issue a StartStopUnit command to stop the device.
1173	 */
1174	sc->SSU_started = TRUE;
1175	sc->SSU_refcount = 0;
1176	for (targetid = 0; targetid < sc->facts->MaxTargets; targetid++) {
1177		target = &sassc->targets[targetid];
1178		if (target->handle == 0x0) {
1179			continue;
1180		}
1181
1182		ccb = xpt_alloc_ccb_nowait();
1183		if (ccb == NULL) {
1184			mpr_dprint(sc, MPR_FAULT, "Unable to alloc CCB to stop "
1185			    "unit.\n");
1186			return;
1187		}
1188
1189		/*
1190		 * The stop_at_shutdown flag will be set if this device is
1191		 * a SATA direct-access end device.
1192		 */
1193		if (target->stop_at_shutdown) {
1194			if (xpt_create_path(&ccb->ccb_h.path, xpt_periph,
1195			    pathid, targetid, CAM_LUN_WILDCARD) !=
1196			    CAM_REQ_CMP) {
1197				mpr_dprint(sc, MPR_ERROR, "Unable to create "
1198				    "path to stop unit.\n");
1199				xpt_free_ccb(ccb);
1200				return;
1201			}
1202			xpt_path_string(ccb->ccb_h.path, path_str,
1203			    sizeof(path_str));
1204
1205			mpr_dprint(sc, MPR_INFO, "Sending StopUnit: path %s "
1206			    "handle %d\n", path_str, target->handle);
1207
1208			/*
1209			 * Issue a START STOP UNIT command for the target.
1210			 * Increment the SSU counter to be used to count the
1211			 * number of required replies.
1212			 */
1213			mpr_dprint(sc, MPR_INFO, "Incrementing SSU count\n");
1214			sc->SSU_refcount++;
1215			ccb->ccb_h.target_id =
1216			    xpt_path_target_id(ccb->ccb_h.path);
1217			ccb->ccb_h.ppriv_ptr1 = sassc;
1218			scsi_start_stop(&ccb->csio,
1219			    /*retries*/0,
1220			    mprsas_stop_unit_done,
1221			    MSG_SIMPLE_Q_TAG,
1222			    /*start*/FALSE,
1223			    /*load/eject*/0,
1224			    /*immediate*/FALSE,
1225			    MPR_SENSE_LEN,
1226			    /*timeout*/10000);
1227			xpt_action(ccb);
1228		}
1229	}
1230
1231	mpr_unlock(sc);
1232
1233	/*
1234	 * Wait until all of the SSU commands have completed or time has
1235	 * expired (60 seconds).  Pause for 100ms each time through.  If any
1236	 * command times out, the target will be reset in the SCSI command
1237	 * timeout routine.
1238	 */
1239	getmicrotime(&start_time);
1240	while (sc->SSU_refcount) {
1241		pause("mprwait", hz/10);
1242
1243		getmicrotime(&cur_time);
1244		if ((cur_time.tv_sec - start_time.tv_sec) > 60) {
1245			mpr_dprint(sc, MPR_ERROR, "Time has expired waiting "
1246			    "for SSU commands to complete.\n");
1247			break;
1248		}
1249	}
1250}
1251
1252static void
1253mprsas_stop_unit_done(struct cam_periph *periph, union ccb *done_ccb)
1254{
1255	struct mprsas_softc *sassc;
1256	char path_str[64];
1257
1258	sassc = (struct mprsas_softc *)done_ccb->ccb_h.ppriv_ptr1;
1259
1260	xpt_path_string(done_ccb->ccb_h.path, path_str, sizeof(path_str));
1261	mpr_dprint(sassc->sc, MPR_INFO, "Completing stop unit for %s\n",
1262	    path_str);
1263
1264	if (done_ccb == NULL)
1265		return;
1266
1267	/*
1268	 * Nothing more to do except free the CCB and path.  If the command
1269	 * timed out, an abort reset, then target reset will be issued during
1270	 * the SCSI Command process.
1271	 */
1272	xpt_free_path(done_ccb->ccb_h.path);
1273	xpt_free_ccb(done_ccb);
1274}
1275
1276/**
1277 * mprsas_ir_shutdown - IR shutdown notification
1278 * @sc: per adapter object
1279 *
1280 * Sending RAID Action to alert the Integrated RAID subsystem of the IOC that
1281 * the host system is shutting down.
1282 *
1283 * Return nothing.
1284 */
1285void
1286mprsas_ir_shutdown(struct mpr_softc *sc)
1287{
1288	u16 volume_mapping_flags;
1289	u16 ioc_pg8_flags = le16toh(sc->ioc_pg8.Flags);
1290	struct dev_mapping_table *mt_entry;
1291	u32 start_idx, end_idx;
1292	unsigned int id, found_volume = 0;
1293	struct mpr_command *cm;
1294	Mpi2RaidActionRequest_t	*action;
1295	target_id_t targetid;
1296	struct mprsas_target *target;
1297
1298	mpr_dprint(sc, MPR_TRACE, "%s\n", __func__);
1299
1300	/* is IR firmware build loaded? */
1301	if (!sc->ir_firmware)
1302		goto out;
1303
1304	/* are there any volumes?  Look at IR target IDs. */
1305	// TODO-later, this should be looked up in the RAID config structure
1306	// when it is implemented.
1307	volume_mapping_flags = le16toh(sc->ioc_pg8.IRVolumeMappingFlags) &
1308	    MPI2_IOCPAGE8_IRFLAGS_MASK_VOLUME_MAPPING_MODE;
1309	if (volume_mapping_flags == MPI2_IOCPAGE8_IRFLAGS_LOW_VOLUME_MAPPING) {
1310		start_idx = 0;
1311		if (ioc_pg8_flags & MPI2_IOCPAGE8_FLAGS_RESERVED_TARGETID_0)
1312			start_idx = 1;
1313	} else
1314		start_idx = sc->max_devices - sc->max_volumes;
1315	end_idx = start_idx + sc->max_volumes - 1;
1316
1317	for (id = start_idx; id < end_idx; id++) {
1318		mt_entry = &sc->mapping_table[id];
1319		if ((mt_entry->physical_id != 0) &&
1320		    (mt_entry->missing_count == 0)) {
1321			found_volume = 1;
1322			break;
1323		}
1324	}
1325
1326	if (!found_volume)
1327		goto out;
1328
1329	if ((cm = mpr_alloc_command(sc)) == NULL) {
1330		printf("%s: command alloc failed\n", __func__);
1331		goto out;
1332	}
1333
1334	action = (MPI2_RAID_ACTION_REQUEST *)cm->cm_req;
1335	action->Function = MPI2_FUNCTION_RAID_ACTION;
1336	action->Action = MPI2_RAID_ACTION_SYSTEM_SHUTDOWN_INITIATED;
1337	cm->cm_desc.Default.RequestFlags = MPI2_REQ_DESCRIPT_FLAGS_DEFAULT_TYPE;
1338	mpr_lock(sc);
1339	mpr_wait_command(sc, cm, 5, CAN_SLEEP);
1340	mpr_unlock(sc);
1341
1342	/*
1343	 * Don't check for reply, just leave.
1344	 */
1345	if (cm)
1346		mpr_free_command(sc, cm);
1347
1348out:
1349	/*
1350	 * All of the targets must have the correct value set for
1351	 * 'stop_at_shutdown' for the current 'enable_ssu' sysctl variable.
1352	 *
1353	 * The possible values for the 'enable_ssu' variable are:
1354	 * 0: disable to SSD and HDD
1355	 * 1: disable only to HDD (default)
1356	 * 2: disable only to SSD
1357	 * 3: enable to SSD and HDD
1358	 * anything else will default to 1.
1359	 */
1360	for (targetid = 0; targetid < sc->facts->MaxTargets; targetid++) {
1361		target = &sc->sassc->targets[targetid];
1362		if (target->handle == 0x0) {
1363			continue;
1364		}
1365
1366		if (target->supports_SSU) {
1367			switch (sc->enable_ssu) {
1368			case MPR_SSU_DISABLE_SSD_DISABLE_HDD:
1369				target->stop_at_shutdown = FALSE;
1370				break;
1371			case MPR_SSU_DISABLE_SSD_ENABLE_HDD:
1372				target->stop_at_shutdown = TRUE;
1373				if (target->flags & MPR_TARGET_IS_SATA_SSD) {
1374					target->stop_at_shutdown = FALSE;
1375				}
1376				break;
1377			case MPR_SSU_ENABLE_SSD_ENABLE_HDD:
1378				target->stop_at_shutdown = TRUE;
1379				break;
1380			case MPR_SSU_ENABLE_SSD_DISABLE_HDD:
1381			default:
1382				target->stop_at_shutdown = TRUE;
1383				if ((target->flags &
1384				    MPR_TARGET_IS_SATA_SSD) == 0) {
1385					target->stop_at_shutdown = FALSE;
1386				}
1387				break;
1388			}
1389		}
1390	}
1391	mprsas_SSU_to_SATA_devices(sc);
1392}
1393