2 * Copyright (c) 2009 Yahoo! Inc.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
30 /* Debugging tables for MPT2 */
32 /* TODO Move headers to mpsvar */
33 #include <sys/types.h>
34 #include <sys/param.h>
35 #include <sys/systm.h>
36 #include <sys/kernel.h>
37 #include <sys/selinfo.h>
38 #include <sys/module.h>
42 #include <sys/malloc.h>
44 #include <sys/sysctl.h>
45 #include <sys/queue.h>
46 #include <sys/kthread.h>
47 #include <sys/taskqueue.h>
49 #include <machine/bus.h>
50 #include <machine/resource.h>
53 #include <cam/scsi/scsi_all.h>
55 #include <dev/mps/mpi/mpi2_type.h>
56 #include <dev/mps/mpi/mpi2.h>
57 #include <dev/mps/mpi/mpi2_ioc.h>
58 #include <dev/mps/mpi/mpi2_cnfg.h>
59 #include <dev/mps/mpi/mpi2_init.h>
60 #include <dev/mps/mpi/mpi2_tool.h>
61 #include <dev/mps/mps_ioctl.h>
62 #include <dev/mps/mpsvar.h>
63 #include <dev/mps/mps_table.h>
66 mps_describe_table(struct mps_table_lookup *table, u_int code)
70 for (i = 0; table[i].string != NULL; i++) {
71 if (table[i].code == code)
72 return(table[i].string);
74 return(table[i+1].string);
77 struct mps_table_lookup mps_event_names[] = {
79 {"StateChange", 0x02},
80 {"HardResetReceived", 0x05},
81 {"EventChange", 0x0a},
82 {"TaskSetFull", 0x0e},
83 {"SasDeviceStatusChange", 0x0f},
84 {"IrOperationStatus", 0x14},
85 {"SasDiscovery", 0x16},
86 {"SasBroadcastPrimitive", 0x17},
87 {"SasInitDeviceStatusChange", 0x18},
88 {"SasInitTableOverflow", 0x19},
89 {"SasTopologyChangeList", 0x1c},
90 {"SasEnclDeviceStatusChange", 0x1d},
92 {"IrPhysicalDisk", 0x1f},
93 {"IrConfigurationChangeList", 0x20},
94 {"LogEntryAdded", 0x21},
95 {"SasPhyCounter", 0x22},
96 {"GpioInterrupt", 0x23},
97 {"HbdPhyEvent", 0x24},
102 struct mps_table_lookup mps_phystatus_names[] = {
103 {"NewTargetAdded", 0x01},
104 {"TargetGone", 0x02},
105 {"PHYLinkStatusChange", 0x03},
106 {"PHYLinkStatusUnchanged", 0x04},
107 {"TargetMissing", 0x05},
109 {"Unknown Status", 0}
112 struct mps_table_lookup mps_linkrate_names[] = {
113 {"PHY disabled", 0x01},
114 {"Speed Negotiation Failed", 0x02},
115 {"SATA OOB Complete", 0x03},
116 {"SATA Port Selector", 0x04},
117 {"SMP Reset in Progress", 0x05},
122 {"LinkRate Unknown", 0x00}
125 struct mps_table_lookup mps_sasdev0_devtype[] = {
126 {"End Device", 0x01},
127 {"Edge Expander", 0x02},
128 {"Fanout Expander", 0x03},
133 struct mps_table_lookup mps_phyinfo_reason_names[] = {
135 {"Hard Reset", 0x02},
136 {"SMP Phy Control Link Reset", 0x03},
137 {"Loss DWORD Sync", 0x04},
138 {"Multiplex Sequence", 0x05},
139 {"I-T Nexus Loss Timer", 0x06},
140 {"Break Timeout Timer", 0x07},
141 {"PHY Test Function", 0x08},
143 {"Unknown Reason", 0x00}
146 struct mps_table_lookup mps_whoinit_names[] = {
147 {"System BIOS", 0x01},
150 {"Host Driver", 0x04},
151 {"Manufacturing", 0x05},
153 {"Not Initialized", 0x00}
156 struct mps_table_lookup mps_sasdisc_reason[] = {
157 {"Discovery Started", 0x01},
158 {"Discovery Complete", 0x02},
163 struct mps_table_lookup mps_sastopo_exp[] = {
165 {"Not Responding", 0x02},
166 {"Responding", 0x03},
167 {"Delay Not Responding", 0x04},
172 struct mps_table_lookup mps_sasdev_reason[] = {
173 {"SMART Data", 0x05},
174 {"Unsupported", 0x07},
175 {"Internal Device Reset", 0x08},
176 {"Task Abort Internal", 0x09},
177 {"Abort Task Set Internal", 0x0a},
178 {"Clear Task Set Internal", 0x0b},
179 {"Query Task Internal", 0x0c},
180 {"Async Notification", 0x0d},
181 {"Cmp Internal Device Reset", 0x0e},
182 {"Cmp Task Abort Internal", 0x0f},
183 {"Sata Init Failure", 0x10},
189 mps_describe_devinfo(uint32_t devinfo, char *string, int len)
191 snprintf(string, len, "%b,%s", devinfo,
192 "\20" "\4SataHost" "\5SmpInit" "\6StpInit" "\7SspInit"
193 "\10SataDev" "\11SmpTarg" "\12StpTarg" "\13SspTarg" "\14Direct"
194 "\15LsiDev" "\16AtapiDev" "\17SepDev",
195 mps_describe_table(mps_sasdev0_devtype, devinfo & 0x03));
199 _mps_print_iocfacts(struct mps_softc *sc, MPI2_IOC_FACTS_REPLY *facts)
202 MPS_PRINTFIELD_START(sc, "IOCFacts");
203 MPS_PRINTFIELD(sc, facts, MsgVersion, 0x%x);
204 MPS_PRINTFIELD(sc, facts, HeaderVersion, 0x%x);
205 MPS_PRINTFIELD(sc, facts, IOCNumber, %d);
206 MPS_PRINTFIELD(sc, facts, IOCExceptions, 0x%x);
207 MPS_PRINTFIELD(sc, facts, MaxChainDepth, %d);
208 mps_print_field(sc, "WhoInit: %s\n",
209 mps_describe_table(mps_whoinit_names, facts->WhoInit));
210 MPS_PRINTFIELD(sc, facts, NumberOfPorts, %d);
211 MPS_PRINTFIELD(sc, facts, MaxMSIxVectors, %d);
212 MPS_PRINTFIELD(sc, facts, RequestCredit, %d);
213 MPS_PRINTFIELD(sc, facts, ProductID, 0x%x);
214 mps_print_field(sc, "IOCCapabilities: %b\n",
215 facts->IOCCapabilities, "\20" "\3ScsiTaskFull" "\4DiagTrace"
216 "\5SnapBuf" "\6ExtBuf" "\7EEDP" "\10BiDirTarg" "\11Multicast"
217 "\14TransRetry" "\15IR" "\16EventReplay" "\17RaidAccel"
218 "\20MSIXIndex" "\21HostDisc");
219 mps_print_field(sc, "FWVersion= %d-%d-%d-%d\n",
220 facts->FWVersion.Struct.Major,
221 facts->FWVersion.Struct.Minor,
222 facts->FWVersion.Struct.Unit,
223 facts->FWVersion.Struct.Dev);
224 MPS_PRINTFIELD(sc, facts, IOCRequestFrameSize, %d);
225 MPS_PRINTFIELD(sc, facts, MaxInitiators, %d);
226 MPS_PRINTFIELD(sc, facts, MaxTargets, %d);
227 MPS_PRINTFIELD(sc, facts, MaxSasExpanders, %d);
228 MPS_PRINTFIELD(sc, facts, MaxEnclosures, %d);
229 mps_print_field(sc, "ProtocolFlags: %b\n",
230 facts->ProtocolFlags, "\20" "\1ScsiTarg" "\2ScsiInit");
231 MPS_PRINTFIELD(sc, facts, HighPriorityCredit, %d);
232 MPS_PRINTFIELD(sc, facts, MaxReplyDescriptorPostQueueDepth, %d);
233 MPS_PRINTFIELD(sc, facts, ReplyFrameSize, %d);
234 MPS_PRINTFIELD(sc, facts, MaxVolumes, %d);
235 MPS_PRINTFIELD(sc, facts, MaxDevHandle, %d);
236 MPS_PRINTFIELD(sc, facts, MaxPersistentEntries, %d);
240 _mps_print_portfacts(struct mps_softc *sc, MPI2_PORT_FACTS_REPLY *facts)
243 MPS_PRINTFIELD_START(sc, "PortFacts");
244 MPS_PRINTFIELD(sc, facts, PortNumber, %d);
245 MPS_PRINTFIELD(sc, facts, PortType, 0x%x);
246 MPS_PRINTFIELD(sc, facts, MaxPostedCmdBuffers, %d);
250 _mps_print_event(struct mps_softc *sc, MPI2_EVENT_NOTIFICATION_REPLY *event)
253 MPS_PRINTFIELD_START(sc, "EventReply");
254 MPS_PRINTFIELD(sc, event, EventDataLength, %d);
255 MPS_PRINTFIELD(sc, event, AckRequired, %d);
256 mps_print_field(sc, "Event: %s (0x%x)\n",
257 mps_describe_table(mps_event_names, event->Event), event->Event);
258 MPS_PRINTFIELD(sc, event, EventContext, 0x%x);
262 _mps_print_sasdev0(struct mps_softc *sc, MPI2_CONFIG_PAGE_SAS_DEV_0 *buf)
264 MPS_PRINTFIELD_START(sc, "SAS Device Page 0");
265 MPS_PRINTFIELD(sc, buf, Slot, %d);
266 MPS_PRINTFIELD(sc, buf, EnclosureHandle, 0x%x);
267 mps_print_field(sc, "SASAddress: 0x%jx\n",
268 mps_to_u64(&buf->SASAddress));
269 MPS_PRINTFIELD(sc, buf, ParentDevHandle, 0x%x);
270 MPS_PRINTFIELD(sc, buf, PhyNum, %d);
271 MPS_PRINTFIELD(sc, buf, AccessStatus, 0x%x);
272 MPS_PRINTFIELD(sc, buf, DevHandle, 0x%x);
273 MPS_PRINTFIELD(sc, buf, AttachedPhyIdentifier, 0x%x);
274 MPS_PRINTFIELD(sc, buf, ZoneGroup, %d);
275 mps_print_field(sc, "DeviceInfo: %b,%s\n", buf->DeviceInfo,
276 "\20" "\4SataHost" "\5SmpInit" "\6StpInit" "\7SspInit"
277 "\10SataDev" "\11SmpTarg" "\12StpTarg" "\13SspTarg" "\14Direct"
278 "\15LsiDev" "\16AtapiDev" "\17SepDev",
279 mps_describe_table(mps_sasdev0_devtype, buf->DeviceInfo & 0x03));
280 MPS_PRINTFIELD(sc, buf, Flags, 0x%x);
281 MPS_PRINTFIELD(sc, buf, PhysicalPort, %d);
282 MPS_PRINTFIELD(sc, buf, MaxPortConnections, %d);
283 mps_print_field(sc, "DeviceName: 0x%jx\n",
284 mps_to_u64(&buf->DeviceName));
285 MPS_PRINTFIELD(sc, buf, PortGroups, %d);
286 MPS_PRINTFIELD(sc, buf, DmaGroup, %d);
287 MPS_PRINTFIELD(sc, buf, ControlGroup, %d);
291 _mps_print_evt_sas(struct mps_softc *sc, MPI2_EVENT_NOTIFICATION_REPLY *event)
294 _mps_print_event(sc, event);
296 switch(event->Event) {
297 case MPI2_EVENT_SAS_DISCOVERY:
299 MPI2_EVENT_DATA_SAS_DISCOVERY *data;
301 data = (MPI2_EVENT_DATA_SAS_DISCOVERY *)&event->EventData;
302 mps_print_field(sc, "Flags: %b\n", data->Flags,
303 "\20" "\1InProgress" "\2DeviceChange");
304 mps_print_field(sc, "ReasonCode: %s\n",
305 mps_describe_table(mps_sasdisc_reason, data->ReasonCode));
306 MPS_PRINTFIELD(sc, data, PhysicalPort, %d);
307 mps_print_field(sc, "DiscoveryStatus: %b\n",
308 data->DiscoveryStatus, "\20"
309 "\1Loop" "\2UnaddressableDev" "\3DupSasAddr" "\5SmpTimeout"
310 "\6ExpRouteFull" "\7RouteIndexError" "\10SmpFailed"
311 "\11SmpCrcError" "\12SubSubLink" "\13TableTableLink"
312 "\14UnsupDevice" "\15TableSubLink" "\16MultiDomain"
313 "\17MultiSub" "\20MultiSubSub" "\34DownstreamInit"
314 "\35MaxPhys" "\36MaxTargs" "\37MaxExpanders"
318 case MPI2_EVENT_SAS_TOPOLOGY_CHANGE_LIST:
320 MPI2_EVENT_DATA_SAS_TOPOLOGY_CHANGE_LIST *data;
321 MPI2_EVENT_SAS_TOPO_PHY_ENTRY *phy;
324 data = (MPI2_EVENT_DATA_SAS_TOPOLOGY_CHANGE_LIST *)
326 MPS_PRINTFIELD(sc, data, EnclosureHandle, 0x%x);
327 MPS_PRINTFIELD(sc, data, ExpanderDevHandle, 0x%x);
328 MPS_PRINTFIELD(sc, data, NumPhys, %d);
329 MPS_PRINTFIELD(sc, data, NumEntries, %d);
330 MPS_PRINTFIELD(sc, data, StartPhyNum, %d);
331 mps_print_field(sc, "ExpStatus: %s (0x%x)\n",
332 mps_describe_table(mps_sastopo_exp, data->ExpStatus),
334 MPS_PRINTFIELD(sc, data, PhysicalPort, %d);
335 for (i = 0; i < data->NumEntries; i++) {
337 phynum = data->StartPhyNum + i;
339 "PHY[%d].AttachedDevHandle: 0x%04x\n", phynum,
340 phy->AttachedDevHandle);
342 "PHY[%d].LinkRate: %s (0x%x)\n", phynum,
343 mps_describe_table(mps_linkrate_names,
344 (phy->LinkRate >> 4) & 0xf), phy->LinkRate);
345 mps_print_field(sc, "PHY[%d].PhyStatus: %s\n",
346 phynum, mps_describe_table(mps_phystatus_names,
351 case MPI2_EVENT_SAS_ENCL_DEVICE_STATUS_CHANGE:
353 MPI2_EVENT_DATA_SAS_ENCL_DEV_STATUS_CHANGE *data;
355 data = (MPI2_EVENT_DATA_SAS_ENCL_DEV_STATUS_CHANGE *)
357 MPS_PRINTFIELD(sc, data, EnclosureHandle, 0x%x);
358 mps_print_field(sc, "ReasonCode: %s\n",
359 mps_describe_table(mps_sastopo_exp, data->ReasonCode));
360 MPS_PRINTFIELD(sc, data, PhysicalPort, %d);
361 MPS_PRINTFIELD(sc, data, NumSlots, %d);
362 MPS_PRINTFIELD(sc, data, StartSlot, %d);
363 MPS_PRINTFIELD(sc, data, PhyBits, 0x%x);
366 case MPI2_EVENT_SAS_DEVICE_STATUS_CHANGE:
368 MPI2_EVENT_DATA_SAS_DEVICE_STATUS_CHANGE *data;
370 data = (MPI2_EVENT_DATA_SAS_DEVICE_STATUS_CHANGE *)
372 MPS_PRINTFIELD(sc, data, TaskTag, 0x%x);
373 mps_print_field(sc, "ReasonCode: %s\n",
374 mps_describe_table(mps_sasdev_reason, data->ReasonCode));
375 MPS_PRINTFIELD(sc, data, ASC, 0x%x);
376 MPS_PRINTFIELD(sc, data, ASCQ, 0x%x);
377 MPS_PRINTFIELD(sc, data, DevHandle, 0x%x);
378 mps_print_field(sc, "SASAddress: 0x%jx\n",
379 mps_to_u64(&data->SASAddress));
387 _mps_print_expander1(struct mps_softc *sc, MPI2_CONFIG_PAGE_EXPANDER_1 *buf)
389 MPS_PRINTFIELD_START(sc, "SAS Expander Page 1 #%d", buf->Phy);
390 MPS_PRINTFIELD(sc, buf, PhysicalPort, %d);
391 MPS_PRINTFIELD(sc, buf, NumPhys, %d);
392 MPS_PRINTFIELD(sc, buf, Phy, %d);
393 MPS_PRINTFIELD(sc, buf, NumTableEntriesProgrammed, %d);
394 mps_print_field(sc, "ProgrammedLinkRate: %s (0x%x)\n",
395 mps_describe_table(mps_linkrate_names,
396 (buf->ProgrammedLinkRate >> 4) & 0xf), buf->ProgrammedLinkRate);
397 mps_print_field(sc, "HwLinkRate: %s (0x%x)\n",
398 mps_describe_table(mps_linkrate_names,
399 (buf->HwLinkRate >> 4) & 0xf), buf->HwLinkRate);
400 MPS_PRINTFIELD(sc, buf, AttachedDevHandle, 0x%04x);
401 mps_print_field(sc, "PhyInfo Reason: %s (0x%x)\n",
402 mps_describe_table(mps_phyinfo_reason_names,
403 (buf->PhyInfo >> 16) & 0xf), buf->PhyInfo);
404 mps_print_field(sc, "AttachedDeviceInfo: %b,%s\n",
405 buf->AttachedDeviceInfo, "\20" "\4SATAhost" "\5SMPinit" "\6STPinit"
406 "\7SSPinit" "\10SATAdev" "\11SMPtarg" "\12STPtarg" "\13SSPtarg"
407 "\14Direct" "\15LSIdev" "\16ATAPIdev" "\17SEPdev",
408 mps_describe_table(mps_sasdev0_devtype,
409 buf->AttachedDeviceInfo & 0x03));
410 MPS_PRINTFIELD(sc, buf, ExpanderDevHandle, 0x%04x);
411 MPS_PRINTFIELD(sc, buf, ChangeCount, %d);
412 mps_print_field(sc, "NegotiatedLinkRate: %s (0x%x)\n",
413 mps_describe_table(mps_linkrate_names,
414 buf->NegotiatedLinkRate & 0xf), buf->NegotiatedLinkRate);
415 MPS_PRINTFIELD(sc, buf, PhyIdentifier, %d);
416 MPS_PRINTFIELD(sc, buf, AttachedPhyIdentifier, %d);
417 MPS_PRINTFIELD(sc, buf, DiscoveryInfo, 0x%x);
418 MPS_PRINTFIELD(sc, buf, AttachedPhyInfo, 0x%x);
419 mps_print_field(sc, "AttachedPhyInfo Reason: %s (0x%x)\n",
420 mps_describe_table(mps_phyinfo_reason_names,
421 buf->AttachedPhyInfo & 0xf), buf->AttachedPhyInfo);
422 MPS_PRINTFIELD(sc, buf, ZoneGroup, %d);
423 MPS_PRINTFIELD(sc, buf, SelfConfigStatus, 0x%x);
427 _mps_print_sasphy0(struct mps_softc *sc, MPI2_CONFIG_PAGE_SAS_PHY_0 *buf)
429 MPS_PRINTFIELD_START(sc, "SAS PHY Page 0");
430 MPS_PRINTFIELD(sc, buf, OwnerDevHandle, 0x%04x);
431 MPS_PRINTFIELD(sc, buf, AttachedDevHandle, 0x%04x);
432 MPS_PRINTFIELD(sc, buf, AttachedPhyIdentifier, %d);
433 mps_print_field(sc, "AttachedPhyInfo Reason: %s (0x%x)\n",
434 mps_describe_table(mps_phyinfo_reason_names,
435 buf->AttachedPhyInfo & 0xf), buf->AttachedPhyInfo);
436 mps_print_field(sc, "ProgrammedLinkRate: %s (0x%x)\n",
437 mps_describe_table(mps_linkrate_names,
438 (buf->ProgrammedLinkRate >> 4) & 0xf), buf->ProgrammedLinkRate);
439 mps_print_field(sc, "HwLinkRate: %s (0x%x)\n",
440 mps_describe_table(mps_linkrate_names,
441 (buf->HwLinkRate >> 4) & 0xf), buf->HwLinkRate);
442 MPS_PRINTFIELD(sc, buf, ChangeCount, %d);
443 MPS_PRINTFIELD(sc, buf, Flags, 0x%x);
444 mps_print_field(sc, "PhyInfo Reason: %s (0x%x)\n",
445 mps_describe_table(mps_phyinfo_reason_names,
446 (buf->PhyInfo >> 16) & 0xf), buf->PhyInfo);
447 mps_print_field(sc, "NegotiatedLinkRate: %s (0x%x)\n",
448 mps_describe_table(mps_linkrate_names,
449 buf->NegotiatedLinkRate & 0xf), buf->NegotiatedLinkRate);
453 mps_print_sgl(struct mps_softc *sc, struct mps_command *cm, int offset)
455 MPI2_SGE_SIMPLE64 *sge;
456 MPI2_SGE_CHAIN32 *sgc;
457 MPI2_REQUEST_HEADER *req;
458 struct mps_chain *chain = NULL;
462 req = (MPI2_REQUEST_HEADER *)cm->cm_req;
463 frame = (char *)cm->cm_req;
464 sge = (MPI2_SGE_SIMPLE64 *)&frame[offset * 4];
465 printf("SGL for command %p\n", cm);
467 hexdump(frame, 128, NULL, 0);
468 while (frame != NULL) {
469 flags = le32toh(sge->FlagsLength) >> MPI2_SGE_FLAGS_SHIFT;
470 printf("seg%d flags=0x%02x len=0x%06x addr=0x%016jx\n",
471 i, flags, le32toh(sge->FlagsLength) & 0xffffff,
472 mps_to_u64(&sge->Address));
473 if (flags & (MPI2_SGE_FLAGS_END_OF_LIST |
474 MPI2_SGE_FLAGS_END_OF_BUFFER))
478 if (flags & MPI2_SGE_FLAGS_LAST_ELEMENT) {
479 sgc = (MPI2_SGE_CHAIN32 *)sge;
480 printf("chain flags=0x%x len=0x%x Offset=0x%x "
481 "Address=0x%x\n", sgc->Flags, le16toh(sgc->Length),
482 sgc->NextChainOffset, le32toh(sgc->Address));
484 chain = TAILQ_FIRST(&cm->cm_chain_list);
486 chain = TAILQ_NEXT(chain, chain_link);
487 frame = (char *)chain->chain;
488 sge = (MPI2_SGE_SIMPLE64 *)frame;
489 hexdump(frame, 128, NULL, 0);
495 mps_print_scsiio_cmd(struct mps_softc *sc, struct mps_command *cm)
497 MPI2_SCSI_IO_REQUEST *req;
499 req = (MPI2_SCSI_IO_REQUEST *)cm->cm_req;
500 mps_print_sgl(sc, cm, req->SGLOffset0);