xref: /freebsd/sys/dev/mps/mps_sas_lsi.c (revision 6486b015fc84e96725fef22b0e3363351399ae83)
1 /*-
2  * Copyright (c) 2011 LSI Corp.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  *
26  * LSI MPT-Fusion Host Adapter FreeBSD
27  */
28 
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
31 
32 /* Communications core for LSI MPT2 */
33 
34 /* TODO Move headers to mpsvar */
35 #include <sys/types.h>
36 #include <sys/param.h>
37 #include <sys/systm.h>
38 #include <sys/kernel.h>
39 #include <sys/selinfo.h>
40 #include <sys/module.h>
41 #include <sys/bus.h>
42 #include <sys/conf.h>
43 #include <sys/bio.h>
44 #include <sys/malloc.h>
45 #include <sys/uio.h>
46 #include <sys/sysctl.h>
47 #include <sys/endian.h>
48 #include <sys/queue.h>
49 #include <sys/kthread.h>
50 #include <sys/taskqueue.h>
51 #include <sys/sbuf.h>
52 
53 #include <machine/bus.h>
54 #include <machine/resource.h>
55 #include <sys/rman.h>
56 
57 #include <machine/stdarg.h>
58 
59 #include <cam/cam.h>
60 #include <cam/cam_ccb.h>
61 #include <cam/cam_debug.h>
62 #include <cam/cam_sim.h>
63 #include <cam/cam_xpt_sim.h>
64 #include <cam/cam_xpt_periph.h>
65 #include <cam/cam_periph.h>
66 #include <cam/scsi/scsi_all.h>
67 #include <cam/scsi/scsi_message.h>
68 
69 #include <dev/mps/mpi/mpi2_type.h>
70 #include <dev/mps/mpi/mpi2.h>
71 #include <dev/mps/mpi/mpi2_ioc.h>
72 #include <dev/mps/mpi/mpi2_sas.h>
73 #include <dev/mps/mpi/mpi2_cnfg.h>
74 #include <dev/mps/mpi/mpi2_init.h>
75 #include <dev/mps/mpi/mpi2_raid.h>
76 #include <dev/mps/mpi/mpi2_tool.h>
77 #include <dev/mps/mps_ioctl.h>
78 #include <dev/mps/mpsvar.h>
79 #include <dev/mps/mps_table.h>
80 #include <dev/mps/mps_sas.h>
81 
82 /* For Hashed SAS Address creation for SATA Drives */
83 #define MPT2SAS_SN_LEN 20
84 #define MPT2SAS_MN_LEN 40
85 
86 struct mps_fw_event_work {
87 	u16			event;
88 	void			*event_data;
89 	TAILQ_ENTRY(mps_fw_event_work)	ev_link;
90 };
91 
92 union _sata_sas_address {
93 	u8 wwid[8];
94 	struct {
95 		u32 high;
96 		u32 low;
97 	} word;
98 };
99 
100 /*
101  * define the IDENTIFY DEVICE structure
102  */
103 struct _ata_identify_device_data {
104 	u16 reserved1[10];	/* 0-9 */
105 	u16 serial_number[10];	/* 10-19 */
106 	u16 reserved2[7];	/* 20-26 */
107 	u16 model_number[20];	/* 27-46*/
108 	u16 reserved3[209];	/* 47-255*/
109 };
110 static u32 event_count;
111 static void mpssas_fw_work(struct mps_softc *sc,
112     struct mps_fw_event_work *fw_event);
113 static void mpssas_fw_event_free(struct mps_softc *,
114     struct mps_fw_event_work *);
115 static int mpssas_add_device(struct mps_softc *sc, u16 handle, u8 linkrate);
116 static int mpssas_get_sata_identify(struct mps_softc *sc, u16 handle,
117     Mpi2SataPassthroughReply_t *mpi_reply, char *id_buffer, int sz,
118     u32 devinfo);
119 int mpssas_get_sas_address_for_sata_disk(struct mps_softc *sc,
120     u64 *sas_address, u16 handle, u32 device_info);
121 static int mpssas_volume_add(struct mps_softc *sc,
122     u16 handle);
123 
124 void
125 mpssas_evt_handler(struct mps_softc *sc, uintptr_t data,
126     MPI2_EVENT_NOTIFICATION_REPLY *event)
127 {
128 	struct mps_fw_event_work *fw_event;
129 	u16 sz;
130 
131 	mps_dprint(sc, MPS_TRACE, "%s\n", __func__);
132 	mps_print_evt_sas(sc, event);
133 	mpssas_record_event(sc, event);
134 
135 	fw_event = malloc(sizeof(struct mps_fw_event_work), M_MPT2,
136 	     M_ZERO|M_NOWAIT);
137 	if (!fw_event) {
138 		printf("%s: allocate failed for fw_event\n", __func__);
139 		return;
140 	}
141 	sz = le16toh(event->EventDataLength) * 4;
142 	fw_event->event_data = malloc(sz, M_MPT2, M_ZERO|M_NOWAIT);
143 	if (!fw_event->event_data) {
144 		printf("%s: allocate failed for event_data\n", __func__);
145 		free(fw_event, M_MPT2);
146 		return;
147 	}
148 
149 	bcopy(event->EventData, fw_event->event_data, sz);
150 	fw_event->event = event->Event;
151 	if ((event->Event == MPI2_EVENT_SAS_TOPOLOGY_CHANGE_LIST ||
152 	    event->Event == MPI2_EVENT_SAS_ENCL_DEVICE_STATUS_CHANGE ||
153 	    event->Event == MPI2_EVENT_IR_CONFIGURATION_CHANGE_LIST) &&
154 	    sc->track_mapping_events)
155 		sc->pending_map_events++;
156 
157 	/*
158 	 * When wait_for_port_enable flag is set, make sure that all the events
159 	 * are processed. Increment the startup_refcount and decrement it after
160 	 * events are processed.
161 	 */
162 	if ((event->Event == MPI2_EVENT_SAS_TOPOLOGY_CHANGE_LIST ||
163 	    event->Event == MPI2_EVENT_IR_CONFIGURATION_CHANGE_LIST) &&
164 	    sc->wait_for_port_enable)
165 		mpssas_startup_increment(sc->sassc);
166 
167 	TAILQ_INSERT_TAIL(&sc->sassc->ev_queue, fw_event, ev_link);
168 	taskqueue_enqueue(sc->sassc->ev_tq, &sc->sassc->ev_task);
169 
170 }
171 
172 static void
173 mpssas_fw_event_free(struct mps_softc *sc, struct mps_fw_event_work *fw_event)
174 {
175 
176 	free(fw_event->event_data, M_MPT2);
177 	free(fw_event, M_MPT2);
178 }
179 
180 /**
181  * _mps_fw_work - delayed task for processing firmware events
182  * @sc: per adapter object
183  * @fw_event: The fw_event_work object
184  * Context: user.
185  *
186  * Return nothing.
187  */
188 static void
189 mpssas_fw_work(struct mps_softc *sc, struct mps_fw_event_work *fw_event)
190 {
191 	struct mpssas_softc *sassc;
192 	sassc = sc->sassc;
193 
194 	mps_dprint(sc, MPS_INFO, "(%d)->(%s) Working on  Event: [%x]\n",
195 			event_count++,__func__,fw_event->event);
196 	switch (fw_event->event) {
197 	case MPI2_EVENT_SAS_TOPOLOGY_CHANGE_LIST:
198 	{
199 		MPI2_EVENT_DATA_SAS_TOPOLOGY_CHANGE_LIST *data;
200 		MPI2_EVENT_SAS_TOPO_PHY_ENTRY *phy;
201 		int i;
202 
203 		data = (MPI2_EVENT_DATA_SAS_TOPOLOGY_CHANGE_LIST *)
204 		    fw_event->event_data;
205 
206 		mps_mapping_topology_change_event(sc, fw_event->event_data);
207 
208 		for (i = 0; i < data->NumEntries; i++) {
209 			phy = &data->PHY[i];
210 			switch (phy->PhyStatus & MPI2_EVENT_SAS_TOPO_RC_MASK) {
211 			case MPI2_EVENT_SAS_TOPO_RC_TARG_ADDED:
212 				if (mpssas_add_device(sc,
213 				    phy->AttachedDevHandle, phy->LinkRate)){
214 					printf("%s: failed to add device with "
215 					    "handle 0x%x\n", __func__,
216 					    phy->AttachedDevHandle);
217 					mpssas_prepare_remove(sassc, phy->
218 					    AttachedDevHandle);
219 				}
220 				break;
221 			case MPI2_EVENT_SAS_TOPO_RC_TARG_NOT_RESPONDING:
222 				mpssas_prepare_remove(sassc, phy->
223 				    AttachedDevHandle);
224 				break;
225 			case MPI2_EVENT_SAS_TOPO_RC_PHY_CHANGED:
226 			case MPI2_EVENT_SAS_TOPO_RC_NO_CHANGE:
227 			case MPI2_EVENT_SAS_TOPO_RC_DELAY_NOT_RESPONDING:
228 			default:
229 				break;
230 			}
231 		}
232 		/*
233 		 * refcount was incremented for this event in
234 		 * mpssas_evt_handler.  Decrement it here because the event has
235 		 * been processed.
236 		 */
237 		mpssas_startup_decrement(sassc);
238 		break;
239 	}
240 	case MPI2_EVENT_SAS_DISCOVERY:
241 	{
242 		MPI2_EVENT_DATA_SAS_DISCOVERY *data;
243 
244 		data = (MPI2_EVENT_DATA_SAS_DISCOVERY *)fw_event->event_data;
245 
246 		if (data->ReasonCode & MPI2_EVENT_SAS_DISC_RC_STARTED)
247 			mps_dprint(sc, MPS_TRACE,"SAS discovery start event\n");
248 		if (data->ReasonCode & MPI2_EVENT_SAS_DISC_RC_COMPLETED) {
249 			mps_dprint(sc, MPS_TRACE,"SAS discovery stop event\n");
250 			sassc->flags &= ~MPSSAS_IN_DISCOVERY;
251 			mpssas_discovery_end(sassc);
252 		}
253 		break;
254 	}
255 	case MPI2_EVENT_SAS_ENCL_DEVICE_STATUS_CHANGE:
256 	{
257 		Mpi2EventDataSasEnclDevStatusChange_t *data;
258 		data = (Mpi2EventDataSasEnclDevStatusChange_t *)
259 		    fw_event->event_data;
260 		mps_mapping_enclosure_dev_status_change_event(sc,
261 		    fw_event->event_data);
262 		break;
263 	}
264 	case MPI2_EVENT_IR_CONFIGURATION_CHANGE_LIST:
265 	{
266 		Mpi2EventIrConfigElement_t *element;
267 		int i;
268 		u8 foreign_config;
269 		Mpi2EventDataIrConfigChangeList_t *event_data;
270 		struct mpssas_target *targ;
271 		unsigned int id;
272 
273 		event_data = fw_event->event_data;
274 		foreign_config = (le32toh(event_data->Flags) &
275 		    MPI2_EVENT_IR_CHANGE_FLAGS_FOREIGN_CONFIG) ? 1 : 0;
276 
277 		element =
278 		    (Mpi2EventIrConfigElement_t *)&event_data->ConfigElement[0];
279 		id = mps_mapping_get_raid_id_from_handle
280 		    (sc, element->VolDevHandle);
281 
282 		mps_mapping_ir_config_change_event(sc, event_data);
283 
284 		for (i = 0; i < event_data->NumElements; i++, element++) {
285 			switch (element->ReasonCode) {
286 			case MPI2_EVENT_IR_CHANGE_RC_VOLUME_CREATED:
287 			case MPI2_EVENT_IR_CHANGE_RC_ADDED:
288 				if (!foreign_config) {
289 					if (mpssas_volume_add(sc, le16toh(element->VolDevHandle))){
290 						printf("%s: failed to add RAID "
291 						    "volume with handle 0x%x\n",
292 						    __func__, le16toh(element->
293 						    VolDevHandle));
294 					}
295 				}
296 				break;
297 			case MPI2_EVENT_IR_CHANGE_RC_VOLUME_DELETED:
298 			case MPI2_EVENT_IR_CHANGE_RC_REMOVED:
299 				/*
300 				 * Rescan after volume is deleted or removed.
301 				 */
302 				if (!foreign_config) {
303 					if (id == MPS_MAP_BAD_ID) {
304 						printf("%s: could not get ID "
305 						    "for volume with handle "
306 						    "0x%04x\n", __func__,
307 						    element->VolDevHandle);
308 						break;
309 					}
310 
311 					targ = &sassc->targets[id];
312 					targ->handle = 0x0;
313 					targ->encl_slot = 0x0;
314 					targ->encl_handle = 0x0;
315 					targ->exp_dev_handle = 0x0;
316 					targ->phy_num = 0x0;
317 					targ->linkrate = 0x0;
318 					mpssas_rescan_target(sc, targ);
319 					printf("RAID target id 0x%x removed\n",
320 					    targ->tid);
321 				}
322 				break;
323 			case MPI2_EVENT_IR_CHANGE_RC_PD_CREATED:
324 			case MPI2_EVENT_IR_CHANGE_RC_HIDE:
325 				/*
326 				 * Phys Disk of a volume has been created.  Hide
327 				 * it from the OS.
328 				 */
329 				targ = mpssas_find_target_by_handle(sassc, 0, element->PhysDiskDevHandle);
330 				if (targ == NULL)
331 					break;
332 
333 				targ->flags |= MPS_TARGET_FLAGS_RAID_COMPONENT;
334 				mpssas_rescan_target(sc, targ);
335 
336 				break;
337 			case MPI2_EVENT_IR_CHANGE_RC_PD_DELETED:
338 				/*
339 				 * Phys Disk of a volume has been deleted.
340 				 * Expose it to the OS.
341 				 */
342 				if (mpssas_add_device(sc,
343 				    element->PhysDiskDevHandle, 0)){
344 					printf("%s: failed to add device with "
345 					    "handle 0x%x\n", __func__,
346 					    element->PhysDiskDevHandle);
347 					mpssas_prepare_remove(sassc, element->
348 					    PhysDiskDevHandle);
349 				}
350 				break;
351 			}
352 		}
353 		/*
354 		 * refcount was incremented for this event in
355 		 * mpssas_evt_handler.  Decrement it here because the event has
356 		 * been processed.
357 		 */
358 		mpssas_startup_decrement(sassc);
359 		break;
360 	}
361 	case MPI2_EVENT_IR_VOLUME:
362 	{
363 		Mpi2EventDataIrVolume_t *event_data = fw_event->event_data;
364 
365 		/*
366 		 * Informational only.
367 		 */
368 		mps_dprint(sc, MPS_INFO, "Received IR Volume event:\n");
369 		switch (event_data->ReasonCode) {
370 		case MPI2_EVENT_IR_VOLUME_RC_SETTINGS_CHANGED:
371 			mps_dprint(sc, MPS_INFO, "   Volume Settings "
372 			    "changed from 0x%x to 0x%x for Volome with "
373 			    "handle 0x%x", event_data->PreviousValue,
374 			    event_data->NewValue,
375 			    event_data->VolDevHandle);
376 			break;
377 		case MPI2_EVENT_IR_VOLUME_RC_STATUS_FLAGS_CHANGED:
378 			mps_dprint(sc, MPS_INFO, "   Volume Status "
379 			    "changed from 0x%x to 0x%x for Volome with "
380 			    "handle 0x%x", event_data->PreviousValue,
381 			    event_data->NewValue,
382 			    event_data->VolDevHandle);
383 			break;
384 		case MPI2_EVENT_IR_VOLUME_RC_STATE_CHANGED:
385 			mps_dprint(sc, MPS_INFO, "   Volume State "
386 			    "changed from 0x%x to 0x%x for Volome with "
387 			    "handle 0x%x", event_data->PreviousValue,
388 			    event_data->NewValue,
389 			    event_data->VolDevHandle);
390 				u32 state;
391 				struct mpssas_target *targ;
392 				state = le32toh(event_data->NewValue);
393 				switch (state) {
394 				case MPI2_RAID_VOL_STATE_MISSING:
395 				case MPI2_RAID_VOL_STATE_FAILED:
396 					mpssas_prepare_volume_remove(sassc, event_data->
397 							VolDevHandle);
398 					break;
399 
400 				case MPI2_RAID_VOL_STATE_ONLINE:
401 				case MPI2_RAID_VOL_STATE_DEGRADED:
402 				case MPI2_RAID_VOL_STATE_OPTIMAL:
403 					targ = mpssas_find_target_by_handle(sassc, 0, event_data->VolDevHandle);
404 					if (targ) {
405 						printf("%s %d: Volume handle 0x%x is already added \n",
406 							       	__func__, __LINE__ , event_data->VolDevHandle);
407 						break;
408 					}
409 					if (mpssas_volume_add(sc, le16toh(event_data->VolDevHandle))) {
410 						printf("%s: failed to add RAID "
411 							"volume with handle 0x%x\n",
412 							__func__, le16toh(event_data->
413 							VolDevHandle));
414 					}
415 					break;
416 				default:
417 					break;
418 				}
419 			break;
420 		default:
421 			break;
422 		}
423 		break;
424 	}
425 	case MPI2_EVENT_IR_PHYSICAL_DISK:
426 	{
427 		Mpi2EventDataIrPhysicalDisk_t *event_data =
428 		    fw_event->event_data;
429 		struct mpssas_target *targ;
430 
431 		/*
432 		 * Informational only.
433 		 */
434 		mps_dprint(sc, MPS_INFO, "Received IR Phys Disk event:\n");
435 		switch (event_data->ReasonCode) {
436 		case MPI2_EVENT_IR_PHYSDISK_RC_SETTINGS_CHANGED:
437 			mps_dprint(sc, MPS_INFO, "   Phys Disk Settings "
438 			    "changed from 0x%x to 0x%x for Phys Disk Number "
439 			    "%d and handle 0x%x at Enclosure handle 0x%x, Slot "
440 			    "%d\n", event_data->PreviousValue,
441 			    event_data->NewValue, event_data->PhysDiskNum,
442 			    event_data->PhysDiskDevHandle,
443 			    event_data->EnclosureHandle, event_data->Slot);
444 			break;
445 		case MPI2_EVENT_IR_PHYSDISK_RC_STATUS_FLAGS_CHANGED:
446 			mps_dprint(sc, MPS_INFO, "   Phys Disk Status changed "
447 			    "from 0x%x to 0x%x for Phys Disk Number %d and "
448 			    "handle 0x%x at Enclosure handle 0x%x, Slot %d\n",
449 			    event_data->PreviousValue, event_data->NewValue,
450 			    event_data->PhysDiskNum,
451 			    event_data->PhysDiskDevHandle,
452 			    event_data->EnclosureHandle, event_data->Slot);
453 			break;
454 		case MPI2_EVENT_IR_PHYSDISK_RC_STATE_CHANGED:
455 			mps_dprint(sc, MPS_INFO, "   Phys Disk State changed "
456 			    "from 0x%x to 0x%x for Phys Disk Number %d and "
457 			    "handle 0x%x at Enclosure handle 0x%x, Slot %d\n",
458 			    event_data->PreviousValue, event_data->NewValue,
459 			    event_data->PhysDiskNum,
460 			    event_data->PhysDiskDevHandle,
461 			    event_data->EnclosureHandle, event_data->Slot);
462 			switch (event_data->NewValue) {
463 				case MPI2_RAID_PD_STATE_ONLINE:
464 				case MPI2_RAID_PD_STATE_DEGRADED:
465 				case MPI2_RAID_PD_STATE_REBUILDING:
466 				case MPI2_RAID_PD_STATE_OPTIMAL:
467 				case MPI2_RAID_PD_STATE_HOT_SPARE:
468 					targ = mpssas_find_target_by_handle(sassc, 0,
469 							event_data->PhysDiskDevHandle);
470 					if (targ) {
471 						targ->flags |= MPS_TARGET_FLAGS_RAID_COMPONENT;
472 						printf("%s %d: Found Target for handle 0x%x.  \n",
473 						__func__, __LINE__ , event_data->PhysDiskDevHandle);
474 					}
475 				break;
476 				case MPI2_RAID_PD_STATE_OFFLINE:
477 				case MPI2_RAID_PD_STATE_NOT_CONFIGURED:
478 				case MPI2_RAID_PD_STATE_NOT_COMPATIBLE:
479 				default:
480 					targ = mpssas_find_target_by_handle(sassc, 0,
481 							event_data->PhysDiskDevHandle);
482 					if (targ) {
483 						targ->flags |= ~MPS_TARGET_FLAGS_RAID_COMPONENT;
484 						printf("%s %d: Found Target for handle 0x%x.  \n",
485 						__func__, __LINE__ , event_data->PhysDiskDevHandle);
486 					}
487 				break;
488 			}
489 		default:
490 			break;
491 		}
492 		break;
493 	}
494 	case MPI2_EVENT_IR_OPERATION_STATUS:
495 	{
496 		Mpi2EventDataIrOperationStatus_t *event_data =
497 		    fw_event->event_data;
498 
499 		/*
500 		 * Informational only.
501 		 */
502 		mps_dprint(sc, MPS_INFO, "Received IR Op Status event:\n");
503 		mps_dprint(sc, MPS_INFO, "   RAID Operation of %d is %d "
504 		    "percent complete for Volume with handle 0x%x",
505 		    event_data->RAIDOperation, event_data->PercentComplete,
506 		    event_data->VolDevHandle);
507 		break;
508 	}
509 	case MPI2_EVENT_LOG_ENTRY_ADDED:
510 	{
511 		pMpi2EventDataLogEntryAdded_t	logEntry;
512 		uint16_t			logQualifier;
513 		uint8_t				logCode;
514 
515 		logEntry = (pMpi2EventDataLogEntryAdded_t)fw_event->event_data;
516 		logQualifier = logEntry->LogEntryQualifier;
517 
518 		if (logQualifier == MPI2_WD_LOG_ENTRY) {
519 			logCode = logEntry->LogData[0];
520 
521 			switch (logCode) {
522 			case MPI2_WD_SSD_THROTTLING:
523 				printf("WarpDrive Warning: IO Throttling has "
524 				    "occurred in the WarpDrive subsystem. "
525 				    "Check WarpDrive documentation for "
526 				    "additional details\n");
527 				break;
528 			case MPI2_WD_DRIVE_LIFE_WARN:
529 				printf("WarpDrive Warning: Program/Erase "
530 				    "Cycles for the WarpDrive subsystem in "
531 				    "degraded range. Check WarpDrive "
532 				    "documentation for additional details\n");
533 				break;
534 			case MPI2_WD_DRIVE_LIFE_DEAD:
535 				printf("WarpDrive Fatal Error: There are no "
536 				    "Program/Erase Cycles for the WarpDrive "
537 				    "subsystem. The storage device will be in "
538 				    "read-only mode. Check WarpDrive "
539 				    "documentation for additional details\n");
540 				break;
541 			case MPI2_WD_RAIL_MON_FAIL:
542 				printf("WarpDrive Fatal Error: The Backup Rail "
543 				    "Monitor has failed on the WarpDrive "
544 				    "subsystem. Check WarpDrive documentation "
545 				    "for additional details\n");
546 				break;
547 			default:
548 				break;
549 			}
550 		}
551 		break;
552 	}
553 	case MPI2_EVENT_SAS_DEVICE_STATUS_CHANGE:
554 	case MPI2_EVENT_SAS_BROADCAST_PRIMITIVE:
555 	default:
556 		mps_dprint(sc, MPS_TRACE,"Unhandled event 0x%0X\n",
557 		    fw_event->event);
558 		break;
559 
560 	}
561 	mps_dprint(sc, MPS_INFO, "(%d)->(%s) Event Free: [%x]\n",event_count,__func__, fw_event->event);
562 	mpssas_fw_event_free(sc, fw_event);
563 }
564 
565 void
566 mpssas_firmware_event_work(void *arg, int pending)
567 {
568 	struct mps_fw_event_work *fw_event;
569 	struct mps_softc *sc;
570 
571 	sc = (struct mps_softc *)arg;
572 	mps_lock(sc);
573 	while ((fw_event = TAILQ_FIRST(&sc->sassc->ev_queue)) != NULL) {
574 		TAILQ_REMOVE(&sc->sassc->ev_queue, fw_event, ev_link);
575 		mpssas_fw_work(sc, fw_event);
576 	}
577 	mps_unlock(sc);
578 }
579 
580 static int
581 mpssas_add_device(struct mps_softc *sc, u16 handle, u8 linkrate){
582 	char devstring[80];
583 	struct mpssas_softc *sassc;
584 	struct mpssas_target *targ;
585 	Mpi2ConfigReply_t mpi_reply;
586 	Mpi2SasDevicePage0_t config_page;
587 	uint64_t sas_address, sata_sas_address;
588 	uint64_t parent_sas_address = 0;
589 	u16 ioc_pg8_flags = le16toh(sc->ioc_pg8.Flags);
590 	u32 device_info, parent_devinfo = 0;
591 	unsigned int id;
592 	int ret;
593 	int error = 0;
594 
595 	sassc = sc->sassc;
596 	mpssas_startup_increment(sassc);
597 	if ((mps_config_get_sas_device_pg0(sc, &mpi_reply, &config_page,
598 	     MPI2_SAS_DEVICE_PGAD_FORM_HANDLE, handle))) {
599 		printf("%s: error reading SAS device page0\n", __func__);
600 		error = ENXIO;
601 		goto out;
602 	}
603 
604 	device_info = le32toh(config_page.DeviceInfo);
605 
606 	if (((device_info & MPI2_SAS_DEVICE_INFO_SMP_TARGET) == 0)
607 	 && (config_page.ParentDevHandle != 0)) {
608 		Mpi2ConfigReply_t tmp_mpi_reply;
609 		Mpi2SasDevicePage0_t parent_config_page;
610 
611 		if ((mps_config_get_sas_device_pg0(sc, &tmp_mpi_reply,
612 		     &parent_config_page, MPI2_SAS_DEVICE_PGAD_FORM_HANDLE,
613 		     le16toh(config_page.ParentDevHandle)))) {
614 			printf("%s: error reading SAS device %#x page0\n",
615 			       __func__, le16toh(config_page.ParentDevHandle));
616 		} else {
617 			parent_sas_address = parent_config_page.SASAddress.High;
618 			parent_sas_address = (parent_sas_address << 32) |
619 				parent_config_page.SASAddress.Low;
620 			parent_devinfo = le32toh(parent_config_page.DeviceInfo);
621 		}
622 	}
623 	/* TODO Check proper endianess */
624 	sas_address = config_page.SASAddress.High;
625 	sas_address = (sas_address << 32) |
626 	    config_page.SASAddress.Low;
627 
628 	if ((ioc_pg8_flags & MPI2_IOCPAGE8_FLAGS_MASK_MAPPING_MODE)
629 		    == MPI2_IOCPAGE8_FLAGS_DEVICE_PERSISTENCE_MAPPING) {
630 		if (device_info & MPI2_SAS_DEVICE_INFO_SATA_DEVICE) {
631 			ret = mpssas_get_sas_address_for_sata_disk(sc,
632 			    &sata_sas_address, handle, device_info);
633 			if (!ret)
634 				id = mps_mapping_get_sas_id(sc,
635 				    sata_sas_address, handle);
636 			else
637 				id = mps_mapping_get_sas_id(sc,
638 				    sas_address, handle);
639 		} else
640 			id = mps_mapping_get_sas_id(sc, sas_address,
641 			    handle);
642 	} else
643 		id = mps_mapping_get_sas_id(sc, sas_address, handle);
644 
645 	if (id == MPS_MAP_BAD_ID) {
646 		printf("failure at %s:%d/%s()! Could not get ID for device "
647 		    "with handle 0x%04x\n", __FILE__, __LINE__, __func__,
648 		    handle);
649 		error = ENXIO;
650 		goto out;
651 	}
652 	mps_dprint(sc, MPS_INFO, "SAS Address from SAS device page0 = %jx\n",
653 	    sas_address);
654 	targ = &sassc->targets[id];
655 	targ->devinfo = device_info;
656 	targ->devname = le32toh(config_page.DeviceName.High);
657 	targ->devname = (targ->devname << 32) |
658 	    le32toh(config_page.DeviceName.Low);
659 	targ->encl_handle = le16toh(config_page.EnclosureHandle);
660 	targ->encl_slot = le16toh(config_page.Slot);
661 	targ->handle = handle;
662 	targ->parent_handle = le16toh(config_page.ParentDevHandle);
663 	targ->sasaddr = mps_to_u64(&config_page.SASAddress);
664 	targ->parent_sasaddr = le64toh(parent_sas_address);
665 	targ->parent_devinfo = parent_devinfo;
666 	targ->tid = id;
667 	targ->linkrate = (linkrate>>4);
668 	targ->flags = 0;
669 	TAILQ_INIT(&targ->commands);
670 	TAILQ_INIT(&targ->timedout_commands);
671 	SLIST_INIT(&targ->luns);
672 	mps_describe_devinfo(targ->devinfo, devstring, 80);
673 	mps_dprint(sc, MPS_INFO, "Found device <%s> <%s> <0x%04x> <%d/%d>\n", devstring,
674 	    mps_describe_table(mps_linkrate_names, targ->linkrate),
675 	    targ->handle, targ->encl_handle, targ->encl_slot);
676 	if ((sassc->flags & MPSSAS_IN_STARTUP) == 0)
677 		mpssas_rescan_target(sc, targ);
678 	mps_dprint(sc, MPS_INFO, "Target id 0x%x added\n", targ->tid);
679 out:
680 	mpssas_startup_decrement(sassc);
681 	return (error);
682 
683 }
684 
685 int
686 mpssas_get_sas_address_for_sata_disk(struct mps_softc *sc,
687     u64 *sas_address, u16 handle, u32 device_info)
688 {
689 	Mpi2SataPassthroughReply_t mpi_reply;
690 	int i, rc, try_count;
691 	u32 *bufferptr;
692 	union _sata_sas_address hash_address;
693 	struct _ata_identify_device_data ata_identify;
694 	u8 buffer[MPT2SAS_MN_LEN + MPT2SAS_SN_LEN];
695 	u32 ioc_status;
696 	u8 sas_status;
697 
698 	memset(&ata_identify, 0, sizeof(ata_identify));
699 	try_count = 0;
700 	do {
701 		rc = mpssas_get_sata_identify(sc, handle, &mpi_reply,
702 		    (char *)&ata_identify, sizeof(ata_identify), device_info);
703 		try_count++;
704 		ioc_status = le16toh(mpi_reply.IOCStatus)
705 		    & MPI2_IOCSTATUS_MASK;
706 		sas_status = mpi_reply.SASStatus;
707 	} while ((rc == -EAGAIN || ioc_status || sas_status) &&
708 	    (try_count < 5));
709 
710 	if (rc == 0 && !ioc_status && !sas_status) {
711 		mps_dprint(sc, MPS_INFO, "%s: got SATA identify successfully "
712 			   "for handle = 0x%x with try_count = %d\n",
713 			   __func__, handle, try_count);
714 	} else {
715 		mps_dprint(sc, MPS_INFO, "%s: handle = 0x%x failed\n",
716 			   __func__, handle);
717 		return -1;
718 	}
719 	/* Copy & byteswap the 40 byte model number to a buffer */
720 	for (i = 0; i < MPT2SAS_MN_LEN; i += 2) {
721 		buffer[i] = ((u8 *)ata_identify.model_number)[i + 1];
722 		buffer[i + 1] = ((u8 *)ata_identify.model_number)[i];
723 	}
724 	/* Copy & byteswap the 20 byte serial number to a buffer */
725 	for (i = 0; i < MPT2SAS_SN_LEN; i += 2) {
726 		buffer[MPT2SAS_MN_LEN + i] =
727 			((u8 *)ata_identify.serial_number)[i + 1];
728 		buffer[MPT2SAS_MN_LEN + i + 1] =
729 			((u8 *)ata_identify.serial_number)[i];
730 	}
731 	bufferptr = (u32 *)buffer;
732 	/* There are 60 bytes to hash down to 8. 60 isn't divisible by 8,
733 	 * so loop through the first 56 bytes (7*8),
734 	 * and then add in the last dword.
735 	 */
736 	hash_address.word.low  = 0;
737 	hash_address.word.high = 0;
738 	for (i = 0; (i < ((MPT2SAS_MN_LEN+MPT2SAS_SN_LEN)/8)); i++) {
739 		hash_address.word.low += *bufferptr;
740 		bufferptr++;
741 		hash_address.word.high += *bufferptr;
742 		bufferptr++;
743 	}
744 	/* Add the last dword */
745 	hash_address.word.low += *bufferptr;
746 	/* Make sure the hash doesn't start with 5, because it could clash
747 	 * with a SAS address. Change 5 to a D.
748 	 */
749 	if ((hash_address.word.high & 0x000000F0) == (0x00000050))
750 		hash_address.word.high |= 0x00000080;
751 	*sas_address = (u64)hash_address.wwid[0] << 56 |
752 	    (u64)hash_address.wwid[1] << 48 | (u64)hash_address.wwid[2] << 40 |
753 	    (u64)hash_address.wwid[3] << 32 | (u64)hash_address.wwid[4] << 24 |
754 	    (u64)hash_address.wwid[5] << 16 | (u64)hash_address.wwid[6] <<  8 |
755 	    (u64)hash_address.wwid[7];
756 	return 0;
757 }
758 
759 static int
760 mpssas_get_sata_identify(struct mps_softc *sc, u16 handle,
761     Mpi2SataPassthroughReply_t *mpi_reply, char *id_buffer, int sz, u32 devinfo)
762 {
763 	Mpi2SataPassthroughRequest_t *mpi_request;
764 	Mpi2SataPassthroughReply_t *reply;
765 	struct mps_command *cm;
766 	char *buffer;
767 	int error = 0;
768 
769 	buffer = malloc( sz, M_MPT2, M_NOWAIT | M_ZERO);
770 	if (!buffer)
771 		return ENOMEM;
772 
773 	if ((cm = mps_alloc_command(sc)) == NULL)
774 		return (EBUSY);
775 	mpi_request = (MPI2_SATA_PASSTHROUGH_REQUEST *)cm->cm_req;
776 	bzero(mpi_request,sizeof(MPI2_SATA_PASSTHROUGH_REQUEST));
777 	mpi_request->Function = MPI2_FUNCTION_SATA_PASSTHROUGH;
778 	mpi_request->VF_ID = 0;
779 	mpi_request->DevHandle = htole16(handle);
780 	mpi_request->PassthroughFlags = (MPI2_SATA_PT_REQ_PT_FLAGS_PIO |
781 	    MPI2_SATA_PT_REQ_PT_FLAGS_READ);
782 	mpi_request->DataLength = htole32(sz);
783 	mpi_request->CommandFIS[0] = 0x27;
784 	mpi_request->CommandFIS[1] = 0x80;
785 	mpi_request->CommandFIS[2] =  (devinfo &
786 	    MPI2_SAS_DEVICE_INFO_ATAPI_DEVICE) ? 0xA1 : 0xEC;
787 	cm->cm_sge = &mpi_request->SGL;
788 	cm->cm_sglsize = sizeof(MPI2_SGE_IO_UNION);
789 	cm->cm_flags = MPS_CM_FLAGS_SGE_SIMPLE | MPS_CM_FLAGS_DATAIN;
790 	cm->cm_desc.Default.RequestFlags = MPI2_REQ_DESCRIPT_FLAGS_DEFAULT_TYPE;
791 	cm->cm_data = buffer;
792 	cm->cm_length = htole32(sz);
793 	error = mps_request_polled(sc, cm);
794 	reply = (Mpi2SataPassthroughReply_t *)cm->cm_reply;
795 	if (error || (reply == NULL)) {
796 		/* FIXME */
797 		/* If the poll returns error then we need to do diag reset */
798 		printf("%s: poll for page completed with error %d",
799 		    __func__, error);
800 		error = ENXIO;
801 		goto out;
802 	}
803 	bcopy(buffer, id_buffer, sz);
804 	bcopy(reply, mpi_reply, sizeof(Mpi2SataPassthroughReply_t));
805 	if ((reply->IOCStatus & MPI2_IOCSTATUS_MASK) !=
806 	    MPI2_IOCSTATUS_SUCCESS) {
807 		printf("%s: error reading SATA PASSTHRU; iocstatus = 0x%x\n",
808 		    __func__, reply->IOCStatus);
809 		error = ENXIO;
810 		goto out;
811 	}
812 out:
813 	mps_free_command(sc, cm);
814 	free(buffer, M_MPT2);
815 	return (error);
816 }
817 
818 static int
819 mpssas_volume_add(struct mps_softc *sc, u16 handle)
820 {
821 	struct mpssas_softc *sassc;
822 	struct mpssas_target *targ;
823 	u64 wwid;
824 	unsigned int id;
825 	int error = 0;
826 
827 	sassc = sc->sassc;
828 	mpssas_startup_increment(sassc);
829 	mps_config_get_volume_wwid(sc, handle, &wwid);
830 	if (!wwid) {
831 		printf("%s: invalid WWID; cannot add volume to mapping table\n",
832 		    __func__);
833 		error = ENXIO;
834 		goto out;
835 	}
836 
837 	id = mps_mapping_get_raid_id(sc, wwid, handle);
838 	if (id == MPS_MAP_BAD_ID) {
839 		printf("%s: could not get ID for volume with handle 0x%04x and "
840 		    "WWID 0x%016llx\n", __func__, handle,
841 		    (unsigned long long)wwid);
842 		error = ENXIO;
843 		goto out;
844 	}
845 
846 	targ = &sassc->targets[id];
847 	targ->tid = id;
848 	targ->handle = handle;
849 	targ->devname = wwid;
850 	TAILQ_INIT(&targ->commands);
851 	TAILQ_INIT(&targ->timedout_commands);
852 	SLIST_INIT(&targ->luns);
853 	if ((sassc->flags & MPSSAS_IN_STARTUP) == 0)
854 		mpssas_rescan_target(sc, targ);
855 	mps_dprint(sc, MPS_INFO, "RAID target id %d added (WWID = 0x%jx)\n",
856 	    targ->tid, wwid);
857 out:
858 	mpssas_startup_decrement(sassc);
859 	return (error);
860 }
861 
862 /**
863  * mpssas_ir_shutdown - IR shutdown notification
864  * @sc: per adapter object
865  *
866  * Sending RAID Action to alert the Integrated RAID subsystem of the IOC that
867  * the host system is shutting down.
868  *
869  * Return nothing.
870  */
871 void
872 mpssas_ir_shutdown(struct mps_softc *sc)
873 {
874 	u16 volume_mapping_flags;
875 	u16 ioc_pg8_flags = le16toh(sc->ioc_pg8.Flags);
876 	struct dev_mapping_table *mt_entry;
877 	u32 start_idx, end_idx;
878 	unsigned int id, found_volume = 0;
879 	struct mps_command *cm;
880 	Mpi2RaidActionRequest_t	*action;
881 
882 	mps_dprint(sc, MPS_TRACE, "%s\n", __func__);
883 
884 	/* is IR firmware build loaded? */
885 	if (!sc->ir_firmware)
886 		return;
887 
888 	/* are there any volumes?  Look at IR target IDs. */
889 	// TODO-later, this should be looked up in the RAID config structure
890 	// when it is implemented.
891 	volume_mapping_flags = le16toh(sc->ioc_pg8.IRVolumeMappingFlags) &
892 	    MPI2_IOCPAGE8_IRFLAGS_MASK_VOLUME_MAPPING_MODE;
893 	if (volume_mapping_flags == MPI2_IOCPAGE8_IRFLAGS_LOW_VOLUME_MAPPING) {
894 		start_idx = 0;
895 		if (ioc_pg8_flags & MPI2_IOCPAGE8_FLAGS_RESERVED_TARGETID_0)
896 			start_idx = 1;
897 	} else
898 		start_idx = sc->max_devices - sc->max_volumes;
899 	end_idx = start_idx + sc->max_volumes - 1;
900 
901 	for (id = start_idx; id < end_idx; id++) {
902 		mt_entry = &sc->mapping_table[id];
903 		if ((mt_entry->physical_id != 0) &&
904 		    (mt_entry->missing_count == 0)) {
905 			found_volume = 1;
906 			break;
907 		}
908 	}
909 
910 	if (!found_volume)
911 		return;
912 
913 	if ((cm = mps_alloc_command(sc)) == NULL) {
914 		printf("%s: command alloc failed\n", __func__);
915 		return;
916 	}
917 
918 	action = (MPI2_RAID_ACTION_REQUEST *)cm->cm_req;
919 	action->Function = MPI2_FUNCTION_RAID_ACTION;
920 	action->Action = MPI2_RAID_ACTION_SYSTEM_SHUTDOWN_INITIATED;
921 	cm->cm_desc.Default.RequestFlags = MPI2_REQ_DESCRIPT_FLAGS_DEFAULT_TYPE;
922 	mps_lock(sc);
923 	mps_request_polled(sc, cm);
924 	mps_unlock(sc);
925 
926 	/*
927 	 * Don't check for reply, just leave.
928 	 */
929 	if (cm)
930 		mps_free_command(sc, cm);
931 }
932