1IPMCTL-SHOW-DEVICE(1) ipmctl IPMCTL-SHOW-DEVICE(1)
2
6 ipmctl-show-device - Shows information about one or more DCPMMs
7
9 ipmctl show [OPTIONS] -dimm [TARGETS]
10
12 Shows information about one or more DCPMMs.
13
15 -a, -all
16 Shows all attributes.
17 Note
19 The all and display options are exclusive and may not be used
20 together.
21 -d (attributes), -display (attributes)
23 Filters the returned attributes by explicitly specifying a
24 comma-separated list of any of the attributes defined in the Return
25 Data section.
26 Note
28 The all and display options are exclusive and may not be used
29 together.
30 -h, -help
32 Displays help for the command.
33 -o (text|nvmxml), -output (text|nvmxml)
35 Changes the output format. One of: "text" (default) or "nvmxml".
36 -u (B|MB|MiB|GB|GiB|TB| TiB), -units (B|MB|MiB|GB|GiB|TB| TiB)
38 Changes the units that capacities are displayed in for this
39 command. One of: bytes (B), megabytes (MB), mebibytes (MiB),
40 gigabytes (GB), gibibytes (GiB), terabytes (TB) or tebibytes (TiB).
41
43 -dimm (DimmIDs)
44 Restricts output to specific DCPMMs by supplying the DIMM target
45 and one or more comma-separated DCPMM identifiers. The default is
46 to display all DCPMMs.
47 -socket (SocketIDs)
49 Restricts output to the DCPMMs installed on specific sockets by
50 supplying the socket target and one or more comma-separated socket
51 identifiers. The default is to display all sockets.
52 Note
54 If ACPI PMTT table is not present, then DDR4 memory will not be
55 displayed in the filtered socket list.
56
58 Lists a few key fields for each DCPMM.
59 ipmctl show -dimm
61 Lists all properties for DCPMM 0x0001.
63 ipmctl show -a -dimm 0x0001
65 Retrieves specific properties for each DCPMM.
67 ipmctl show -d HealthState,LockState -dimm
69
71 The default behavior is to display a table with the default attributes
72 listed below; applying options changes the output to a more detailed
73 format. Limited information (noted in the table below) is applicable if
74 the DCPMM is not manageable by the software as indicated by the
75 "ManageabilityState" property.
76 Note
78 Some data is endian-swapped for human readability.
79 DimmID
81 (Default) The DCPMM identifier.
82 Capacity
84 (Default) The usable capacity of the DCPMM as reported by the
85 firmware.
86 HealthState
88 (Default) Overall DCPMM health. One of:
89 · Healthy
91 · Noncritical: Maintenance is required.
93 · Critical: Features or performance are degraded due to failure.
95 · Fatal: Data loss has occurred or is imminent. In this case, the
97 firmware will disable the media and access to user data and
98 operations that require use of the media will fail.
99 · Non-functional: The DCPMM is present but is non-responsive via
101 the DDRT communication path. It may be possible to communicate
102 with this DCPMM via SMBus for a subset of commands.
103 · Unmanageable: The DCPMM is not supported by this version of the
105 software
106 · Unknown: Unable to determine the DCPMM health state.
108 HealthStateReason
110 Indicates why the DCPMM is in the current Health State. One or more
111 of:
112 · None
114 · Percentage Remaining less than 1%
116 · Package Sparing occurred
118 · CAP Self-Test warning
120 · Percentage Remaining is 0
122 · Die Failure
124 · AIT DRAM disabled
126 · CAP Self-Test fail
128 · Critical internal failure
130 Refer to the Intel® Optane™ DC Persistent Memory Firmware
132 Interface Specification, document number 556488, Section 4.8
133 SMART and Health.
134 ActionRequired
136 (Default) If there are events for this device that require
137 corrective action or acknowledgment. Refer to the command Section
138 [Show Events] for more information about events. One of:
139 · 0: No action required events
141 · 1: One or more action required events
143 InterfaceFormatCode
145 A comma-delimited list of the JEDEC standard format interface
146 code(s) for the DCPMM where each code is formatted as: code (JEDEC
147 Description or "Unknown").
148 ManageabilityState
150 Ability of the DCPMM host software to manage the DCPMM.
151 Manageability is determined by the interface format code, the
152 vendor identifier, device identifier and the firmware API version.
153 One of:
154 · Manageable: The DCPMM is manageable by the software.
156 · Unmanageable: The DCPMM is not supported by this version of the
158 software.
159 PhysicalID
161 The DCPMM physical identifier (i.e., SMBIOS Type 17 handle).
162 DimmHandle
164 The DCPMM handle formatted as 0xABCD.
165 · A = Socket
167 · B = Memory Controller
169 · C = Channel
171 · D = Slot
173 DimmUID
175 The unique identifier of the DCPMM formatted as
176 VVVV-ML-MMYYSNSNSNSN or VVVV-SNSNSNSN (if the manufacturing
177 information is not available) where:
178 · VVVV = VendorID
180 · ML = ManufacturingLocation
182 · MMYY = ManufacturingDate
184 · SNSNSNSN = SerialNumber
186 SocketID
188 The processor socket identifier (i.e., NUMA node) where the DCPMM
189 is installed.
190 MemControllerID
192 The associated memory controller identifier.
193 ChannelID
195 The associated channel.
196 ChannelPos
198 The DCPMM position in the channel.
199 MemoryType
201 The memory type. One of:
202 · Unknown
204 · DDR4
206 · Logical Non-Volatile Device
208 VendorID
210 The vendor identifier of the DCPMM. This value is presented in big
211 endian format.
212 DeviceID
214 The device identifier of the DCPMM. This value is presented in big
215 endian format.
216 RevisionID
218 The revision identifier of the DCPMM.
219 SubsystemVendorID
221 The vendor identifier of the non-volatile memory subsystem
222 controller. This value is presented in big endian format.
223 SubsystemDeviceID
225 The device identifier of the non-volatile memory subsystem
226 controller.
227 SubsystemRevisionID
229 The revision identifier of the non-volatile memory subsystem
230 controller retrieved from NFIT. This field uses a different
231 encoding than ControllerRevisionID.
232 ManufacturingInfoValid
234 If the manufacturing location and date are valid. One of:
235 · 0: Not valid
237 · 1: Valid
239 ManufacturingLocation
241 The manufacturing location assigned by the vendor or "N/A" if
242 ManufacturingInfoValid is 0.
243 ManufacturingDate
245 The manufacturing date assigned by the vendor or "N/A" if
246 ManufacturingInfoValid is 0.
247 SerialNumber
249 The serial number assigned by the vendor. This value is presented
250 in big endian format.
251 PartNumber
253 The part number assigned by the vendor
254 DeviceLocator
256 A string describing the physically-labeled socket or board position
257 where the memory device is located from the SMBIOS Type 17 Memory
258 Device table.
259 BankLabel
261 A string that identifies the physically labeled bank where the
262 memory device is located from the SMBIOS Type 17 Memory Device
263 table.
264 DataWidth
266 The width in bits used to store user data from the SMBIOS Type 17
267 Memory Device table.
268 TotalWidth
270 The width in bits for data and error correction and/or data
271 redundancy from the SMBIOS Type 17 Memory Device table.
272 Speed
274 The maximum capable speed of the device in megahertz (MHz) from the
275 SMBIOS Type 17 Memory Device table.
276 FormFactor
278 The DCPMM form factor (i.e., SMBIOS Type 17 Memory Device Form
279 Factor). One of:
280 · Unknown
282 · DIMM
284 · SODIMM
286 LockState
288 (Default) The current security state of the persistent memory on
289 the DCPMM. One of:
290 · Unknown - The security state cannot be determined (e.g., when
292 the DCPMM is not manageable by the software).
293 · Disabled - Security is not enabled.
295 · Disabled, Frozen - Security is not enabled. A reboot is
297 required to change the security state.
298 · Unlocked - Security is enabled and unlocked.
300 · Unlocked, Frozen - Security is enabled and unlocked. A reboot
302 is required to change the security state.
303 · Locked - Security is enabled and locked.
305 · Exceeded - The passphrase limit has been reached. A power cycle
307 is required to change the security state.
308 · Not Supported - Security is not supported on the DCPMM.
310 FWVersion
312 (Default) The BCD-formatted revision of the active firmware in the
313 format PN.RN.SV.bbbb where:
314 · PN = 2-digit product number
316 · RN = 2-digit revision number
318 · SN = 2-digit security revision number
320 · bbbb = 4-digit build version
322 Value may be N/A if the DCPMM is not manageable by the software.
324 FWAPIVersion
326 The firmware supported interface revision in the format aa.bb
327 where:
328 · aa = 2-digit major version
330 · bb = 2-digit minor version
332 The firmware interface is intended to be backwards compatible.
334 Therefore, the host software allows management of DCPMMs where
335 this version is less than or equal to the version stored in the
336 host software. Value may be N/A if the DCPMM is not manageable
337 by the software.
338 ActionRequiredEvents
340 A list of the events for this device that require corrective action
341 or acknowledgment in the format: Event [ID] - [Message]. Refer to
342 the command Show Events for more information about events.
343 The following information is only applicable when the DCPMM is
345 manageable by the software as indicated by the "ManageabilityState".
346 ManufacturerID
348 The manufacturer identifier of the DCPMM. This value is presented
349 in big endian format.
350 ControllerRevisionID
352 The controller stepping and revision ID retrieved from the
353 controller FW. This field uses a different encoding than
354 SubsystemRevisionID.
355 IsNew
357 Whether or not the DCPMM is incorporated with the rest of the DCPMM
358 in the system. One of:
359 · 0: Configured
361 · 1: The DCPMM requires configuration.
363 MemoryCapacity
365 Usable DCPMM Memory Mode capacity.
366 AppDirectCapacity
368 Usable DCPMM App Direct capacity.
369 UnconfiguredCapacity
371 DCPMM capacity that is inaccessible because it is not mapped into
372 the system physical address space.
373 InaccessibleCapacity
375 DCPMM capacity that is inaccessible due to:
376 · licensing issue
378 · platform configuration prevents accessing this capacity. For
380 example, MemoryCapacity is configured and available on a DCPMM
381 but MemoryMode is not enabled by BIOS.
382 ReservedCapacity
384 DCPMM capacity reserved for proper alignment.
385 PeakPowerBudget
387 If the DCPMM firmware power management policy is enabled, the power
388 budget in mW used for instantaneous power. Refer to FIS for
389 allowable range and default value.
390 AvgPowerBudget
392 If the DCPMM firmware power management policy is enabled, the power
393 budget in mW used for average power. Refer to FIS for allowable
394 range and default value.
395 MaxAveragePowerBudget
397 Maximum average power budget supported by the DCPMM.
398 PackageSparingCapable
400 Whether or not the DCPMM supports package sparing. One of:
401 · 0: False
403 · 1: True
405 PackageSparingEnabled
407 Whether or not the DCPMM package sparing policy is enabled. One of:
408 · 0: Disabled
410 · 1: Enabled
412 PackageSparesAvailable
414 The number of spare devices available for package sparing.
415 LatchedLastShutdownStatus
417 The status of the last shutdown of the DCPMM. One or more of:
418 · Unknown: The last shutdown status cannot be determined.
420 · FW Flush Complete: FW flush completed.
422 · PM ADR Command: Power management ADR command received.
424 · PM S3: Power management S3 command received.
426 · PM S5: Power management S5 command received.
428 · DDRT Power Fail Command: DDR power fail command received.
430 · PMIC 12V/DDRT 1.2V Power Loss (PLI)
432 · PM Warm Reset: Power management warm reset received.
434 · Thermal Shutdown: Thermal shutdown triggered.
436 · Controller’s FW State Flush Complete: Flush Completed.
438 · Viral Interrupt: Viral interrupt received.
440 · Surprise Clock Stop: Surprise clock stop received.
442 · Write Data Flush Complete: Write data flush completed.
444 · PM S4: Power management S4 command received.
446 · PM Idle: Power management idle received
448 · DDRT Surprise Reset: Surprise reset received
450 UnlatchedLastShutdownStatus
452 The status of the last shutdown status of the DCPMM. Same fields as
453 the Latched Last Shutdown Status with the only difference that LLS
454 details on a dirty shutdown is logged, even if the Latch System
455 Shutdown Status was not enabled. One or more of:
456 · Unknown: The last shutdown status cannot be determined.
458 · FW Flush Complete: FW flush completed.
460 · PM ADR Command: Power management ADR command received.
462 · PM S3: Power management S3 command received.
464 · PM S5: Power management S5 command received.
466 · DDRT Power Fail Command: DDR power fail command received.
468 · PMIC 12V/DDRT 1.2V Power Loss (PLI)
470 · PM Warm Reset: Power management warm reset received.
472 · Thermal Shutdown: Thermal shutdown triggered.
474 · Controller’s FW State Flush Complete: Flush Completed.
476 · Viral Interrupt: Viral interrupt received.
478 · Surprise Clock Stop: Surprise clock stop received.
480 · Write Data Flush Complete: Write data flush completed.
482 · PM S4: Power management S4 command received.
484 · PM Idle: Power management idle received
486 · DDRT Surprise Reset: Surprise reset received
488 LastShutdownTime
490 The time the system was last shutdown.
491 ModesSupported
493 A list of the modes supported by the DCPMM. Refer to the command
494 Show System Capabilities to determine the modes supported by the
495 platform. One or more of:
496 · Memory Mode: DCPMMs act as system memory under the control of
498 the operating system. In Memory Mode, any DDR in the platform
499 will act as a cache working in conjunction with the DCPMM.
500 · App Direct: DCPMMs and DDR act as independent memory resources
502 under direct load/store control of the application.
503 SecurityCapabilities
505 The security features supported by the DCPMM. Zero or more of:
506 · Encryption: The DCPMM supports persistent memory encryption by
508 setting a passphrase.
509 · Erase: The DCPMM is erasable.
511 MasterPassphraseEnabled
513 This property indicates if master passphrase is enabled. If it is
514 disabled, then it cannot be enabled. One of:
515 · 0: Disabled - Cannot be enabled
517 · 1: Enabled - Master passphrase can be changed. Cannot be
519 disabled.
520 ConfigurationStatus
522 The status of the DCPMM memory configuration. One of:
523 · Valid: The configuration is valid.
525 · Not Configured: The DCPMM has not been configured.
527 · Failed - Bad configuration: The configuration is corrupt.
529 · Failed - Broken interleave: This DCPMM is part of an interleave
531 set that is not complete.
532 · Failed - Reverted: The configuration failed and was reverted to
534 the last known good configuration.
535 · Failed - Unsupported: The configuration is not compatible with
537 the installed BIOS.
538 · Unknown: The configuration cannot be determined.
540 SKUViolation
542 The configuration of the DCPMM is unsupported due to a license
543 issue. One of:
544 · 0: False
546 · 1: True
548 ARSStatus
550 The address range scrub (ARS) operation status for the DCPMM. The
551 status is a reflection of the last requested ARS, but not
552 necessarily within the current platform power cycle. One of:
553 · Unknown - The ARS operation status cannot be determined.
555 · Not started - An ARS operation has not started.
557 · In progress - An ARS operation is currently in progress.
559 · Completed - The last ARS operation has completed.
561 · Aborted - The last ARS operation was aborted.
563 OverwriteStatus
565 The overwrite DIMM operation status for the DCPMM. One of:
566 · Unknown - The overwrite DIMM operation status cannot be
568 determined.
569 · Not started - An overwrite DIMM operation was not started on
571 the last boot.
572 · In progress - An overwrite DIMM operation is currently in
574 progress.
575 · Completed - An overwrite DIMM operation completed and a reboot
577 is required to use the DCPMM.
578 ViralPolicy
580 Whether viral policies are enabled on the DCPMM. One of:
581 · 0: Disabled - This is the default.
583 · 1: Enabled - The persistent memory on the DCPMM will be put
585 into read-only mode if the host operating system software
586 detects an uncorrectable error situation and indicates a viral
587 state in order to prevent the spread of damage.
588 ViralState
590 Whether the DCPMM is currently viral. One of:
591 · 0: Not Viral
593 · 1: Viral - The viral policies of the DCPMM have switched the
595 persistent memory to read-only mode due to the host operating
596 system software detecting an uncorrectable error situation and
597 indicating a viral state.
598 AitDramEnabled
600 If the DCPMM AIT DRAM is enabled. One of:
601 · 0: Disabled - The device will suffer performance degradation if
603 the AIT DRAM becomes disabled.
604 · 1: Enabled
606 BootStatus
608 The initialization status of the DCPMM as reported by the firmware
609 in the boot status register. One or more of:
610 · Unknown - The boot status register cannot be read.
612 · Success - No errors were reported during initialization.
614 The following statuses indicate that the media is not
616 functional and therefore access to user data and operations
617 that require use of the media will fail.
618 · Media Not Ready - The firmware did not complete media training.
620 · Media Error - The firmware detected an error during media
622 training.
623 · Media Disabled - The firmware disabled the media due to a
625 critical issue.
626 The following statuses indicate that communication with the
628 firmware is not functional.
629 · FW Assert - The firmware reported an assert during
631 initialization.
632 BootStatusRegister
634 The raw hex value of the DCPMM Boot Status Register of the DCPMM
635 ErrorInjectionEnabled
637 Error injection status.
638 · 0: Disabled - This is the default.
640 · 1: Enabled
642 MediaTemperatureInjectionEnabled
644 Media temperature injection status.
645 · 0: Disabled - This is the default.
647 · 1: Enabled
649 SoftwareTriggersEnabled
651 Software trigger status.
652 · 0: Disabled - This is the default.
654 · 1: At least one software trigger enabled.
656 SoftwareTriggersEnabledDetail
658 Comma separated list of software triggers currently enabled. One or
659 more of:
660 · None
662 · Package Sparing
664 · Fatal Error
666 · Percentage Remaining
668 · Dirty Shutdown
670 PoisonErrorInjectionsCounter
672 This counter is incremented each time the set poison error is
673 successfully executed.
674 PoisonErrorClearCounter
676 This counter is incremented each time the clear poison error is
677 successfully executed.
678 MediaTemperatureInjectionsCounter
680 This counter is incremented each time the media temperature is
681 injected.
682 SoftwareTriggersCounter
684 This counter is incremented each time a software trigger is
685 enabled.
686ipmctl 2019-04-10 IPMCTL-SHOW-DEVICE(1)