1IPMCTL-SHOW-DEVICE(1) ipmctl IPMCTL-SHOW-DEVICE(1)
2
3
4
6 ipmctl-show-device - Shows information about one or more PMem modules
7
9 ipmctl show [OPTIONS] -dimm [TARGETS]
10
12 Shows information about one or more PMem modules.
13
15 -a, -all
16 Shows all attributes.
17
18 Note
19 The all and display options are exclusive and may not be used
20 together.
21
22 -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
27 Note
28 The all and display options are exclusive and may not be used
29 together.
30
31 -h, -help
32 Displays help for the command.
33
34 -ddrt
35 Used to specify DDRT as the desired transport protocol for the
36 current invocation of ipmctl.
37
38 -smbus
39 Used to specify SMBUS as the desired transport protocol for the
40 current invocation of ipmctl.
41
42 Note
43 The -ddrt and -smbus options are mutually exclusive and may not be
44 used together.
45
46 -o (text|nvmxml), -output (text|nvmxml)
47 Changes the output format. One of: "text" (default) or "nvmxml".
48
49 -u (B|MB|MiB|GB|GiB|TB| TiB), -units (B|MB|MiB|GB|GiB|TB| TiB)
50 Changes the units that capacities are displayed in for this
51 command. One of: bytes (B), megabytes (MB), mebibytes (MiB),
52 gigabytes (GB), gibibytes (GiB), terabytes (TB) or tebibytes (TiB).
53
55 -dimm [DimmIDs]
56 Restricts output to specific PMem modules by supplying the PMem
57 module target and one or more comma-separated PMem module
58 identifiers. The default is to display all PMem modules.
59
60 -socket [SocketIDs]
61 Restricts output to the PMem modules installed on specific sockets
62 by supplying the socket target and one or more comma-separated
63 socket identifiers. The default is to display all sockets.
64
65 Note
66 If ACPI PMTT table is not present, then DDR4 memory will not be
67 displayed in the filtered socket list.
68
70 Lists a few key fields for each PMem module.
71
72 ipmctl show -dimm
73
74 Lists all properties for PMem module 0x0001.
75
76 ipmctl show -a -dimm 0x0001
77
78 Retrieves specific properties for each PMem module.
79
80 ipmctl show -d HealthState,LockState -dimm
81
83 The default behavior is to display a table with the default attributes
84 listed below; applying options changes the output to a more detailed
85 format. Limited information (noted in the table below) is applicable if
86 the PMem module is not manageable by the software as indicated by the
87 "ManageabilityState" property.
88
89 Note
90 Some data is endian-swapped for human readability.
91
92 DimmID
93 (Default) The PMem module identifier.
94
95 Capacity
96 (Default) The usable capacity of the PMem module as reported by the
97 firmware.
98
99 HealthState
100 (Default) Overall PMem module health. One of:
101
102 · Healthy
103
104 · Noncritical: Maintenance may be required.
105
106 · Critical: Features or performance are degraded due to failure.
107
108 · Fatal: Critical internal state failure (DPA Failure, Internal
109 Buffer Failure, AIT Failure, etc.) is non-recoverable and data
110 loss has occurred or is imminent. In this case, the firmware
111 will disable the media and access to user data and operations
112 that require use of the media will fail.
113
114 · Non-functional: The PMem module is detected and manageable,
115 though some commands and capabilities may be limited. The PMem
116 module has limited communication or another error preventing
117 complete functionality. Common causes include:
118
119 · DDRT memory interface training failure
120
121 · Expected region mapping to SPA range unable to be found
122
123 · Unmanageable: The PMem module has an incompatible firmware API
124 version or hardware revision or is unresponsive (possibly due
125 to a communication interface failure or a firmware/hardware
126 error).
127
128 · Unknown: Unable to determine the PMem module health state.
129 Refer to HealthStateReason for HealthState details.
130
131 HealthStateReason
132 Indicates why the PMem module is in the current Health State. One
133 or more of:
134
135 · None
136
137 · Percentage Remaining less than 1%
138
139 · Package Sparing occurred
140
141 · CAP Self-Test warning
142
143 · Percentage Remaining is 0
144
145 · Die Failure
146
147 · AIT DRAM disabled
148
149 · CAP Self-Test failure
150
151 · Critical internal state failure
152
153 · Performance degraded
154
155 · CAP Self-Test communication failure
156
157 Refer to the Intel® Optane™ Persistent Memory Firmware
158 Interface Specification, document number 556488, Section 4.8
159 SMART and Health.
160
161 InterfaceFormatCode
162 A comma-delimited list of the JEDEC standard format interface codes
163 for the PMem module where each code is formatted as: code (JEDEC
164 Description or "Unknown").
165
166 ManageabilityState
167 Ability of the PMem module host software to manage the PMem module.
168 Manageability is determined by the interface format code, the
169 vendor identifier, device identifier and the firmware API version.
170 One of:
171
172 · Manageable: The PMem module is manageable by the software.
173
174 · Unmanageable: The PMem module is not supported by this version
175 of the software.
176
177 PopulationViolation
178 Memory populations are evaluated based on the "Enforce Population
179 POR" setup option in UEFI Firmware. If enforcement of POR
180 populations is selected, then some PMem module memory may be in
181 population violation. See [PMem modules in non-POR configuration]
182 for details. One of:
183
184 · Yes: The PMem module is in population violation.
185
186 · No: The PMem module is not in population violation.
187
188 PhysicalID
189 The PMem module physical identifier (i.e., SMBIOS Type 17 handle).
190
191 DimmHandle
192 The PMem module handle formatted as 0xABCD.
193
194 · A = Socket
195
196 · B = Memory Controller
197
198 · C = Channel
199
200 · D = Slot
201
202 DimmUID
203 The unique identifier of the PMem module formatted as
204 VVVV-ML-MMYYSNSNSNSN or VVVV-SNSNSNSN (if the manufacturing
205 information is not available) where:
206
207 · VVVV = VendorID
208
209 · ML = ManufacturingLocation
210
211 · MMYY = ManufacturingDate
212
213 · SNSNSNSN = SerialNumber
214
215 SocketID
216 The processor socket identifier (i.e., NUMA node) where the PMem
217 module is installed.
218
219 MemControllerID
220 The associated memory controller identifier.
221
222 ChannelID
223 The associated channel.
224
225 ChannelPos
226 The PMem module position in the channel.
227
228 MemoryType
229 The memory type. One of:
230
231 · Unknown
232
233 · DDR4
234
235 · Logical Non-Volatile Device
236
237 VendorID
238 The vendor identifier of the PMem module. This value is presented
239 in big endian format.
240
241 DeviceID
242 The device identifier of the PMem module. This value is presented
243 in big endian format.
244
245 RevisionID
246 The revision identifier of the PMem module.
247
248 SubsystemVendorID
249 The vendor identifier of the non-volatile memory subsystem
250 controller. This value is presented in big endian format.
251
252 SubsystemDeviceID
253 The device identifier of the non-volatile memory subsystem
254 controller.
255
256 SubsystemRevisionID
257 The revision identifier of the non-volatile memory subsystem
258 controller retrieved from NFIT. This field uses a different
259 encoding than ControllerRevisionID.
260
261 ManufacturingInfoValid
262 If the manufacturing location and date are valid. One of:
263
264 · 0: Not valid
265
266 · 1: Valid
267
268 ManufacturingLocation
269 The manufacturing location assigned by the vendor or "N/A" if
270 ManufacturingInfoValid is 0.
271
272 ManufacturingDate
273 The manufacturing date assigned by the vendor or "N/A" if
274 ManufacturingInfoValid is 0.
275
276 SerialNumber
277 The serial number assigned by the vendor. This value is presented
278 in big endian format.
279
280 PartNumber
281 The part number assigned by the vendor
282
283 DeviceLocator
284 A string describing the physically-labeled socket or board position
285 where the memory device is located from the SMBIOS Type 17 Memory
286 Device table.
287
288 BankLabel
289 A string that identifies the physically labeled bank where the
290 memory device is located from the SMBIOS Type 17 Memory Device
291 table.
292
293 DataWidth
294 The width in bits used to store user data from the SMBIOS Type 17
295 Memory Device table.
296
297 TotalWidth
298 The width in bits for data and error correction and/or data
299 redundancy from the SMBIOS Type 17 Memory Device table.
300
301 Speed
302 The maximum capable speed of the device in megatransfers per second
303 (MT/s) from the SMBIOS Type 17 Memory Device table.
304
305 FormFactor
306 The PMem module form factor (i.e., SMBIOS Type 17 Memory Device
307 Form Factor). One of:
308
309 · Unknown
310
311 · DIMM
312
313 · SODIMM
314
315 LockState
316 The current security state of the persistent memory on the PMem
317 module. One ore more of:
318
319 · Unknown - The security state cannot be determined (e.g., when
320 the PMem module is not manageable by the software).
321
322 · Disabled - Security is not enabled.
323
324 · Unlocked - Security is enabled and unlocked.
325
326 · Locked - Security is enabled and locked.
327
328 · Frozen - A reboot is required to change the security state.
329
330 · Exceeded - The passphrase limit has been reached. A power cycle
331 is required to change the security state.
332
333 · MP Exceeded - The master passphrase limit has been reached. A
334 power cycle is required to change the security state.
335
336 · Not Supported - Security is not supported on the PMem module.
337
338 SVNDowngrade
339 The Opt-in value of SVN Downgrade security opt-in feature for PMem
340 module. One of :
341
342 · Unknown
343
344 · Disabled
345
346 · Enabled
347
348 SecureErasePolicy
349 The Opt-in value of Secure erase policy opt-in feature for PMem
350 module. One of :
351
352 · Unknown
353
354 · No Master Passphrase
355
356 · Master Passphrase Enabled
357
358 S3ResumeOptIn
359 The Opt-in value of S3 Resume security opt-in feature for PMem
360 module. One of :
361
362 · Unknown
363
364 · UnsecureS3
365
366 · SecureS3
367
368 FwActivateOptIn
369 The Opt-in value of Fw Activate security opt-in feature for PMem
370 module. One of :
371
372 · Unknown
373
374 · Disabled
375
376 · Enabled
377
378 FWVersion
379 (Default) The BCD-formatted revision of the active firmware in the
380 format PN.RN.SV.bbbb where:
381
382 · PN = 2-digit product number
383
384 · RN = 2-digit revision number
385
386 · SN = 2-digit security revision number
387
388 · bbbb = 4-digit build version
389
390 Value may be N/A if the PMem module is not manageable by the software.
391
392 FWAPIVersion
393 The firmware supported interface revision in the format aa.bb
394 where:
395
396 · aa = 2-digit major version
397
398 · bb = 2-digit minor version
399
400 The firmware interface is intended to be backwards compatible.
401 Therefore, the host software allows management of PMem modules
402 where this version is less than or equal to the version stored
403 in the host software. Value may be N/A if the PMem module is
404 not manageable by the software.
405
406 The following information is only applicable when the PMem module is
407 manageable by the software as indicated by the "ManageabilityState".
408
409 FWActiveAPIVersion
410 The firmware interface revision locked in the BIOS API handshake in
411 the format aa.bb where:
412
413 · aa = 2-digit major version
414
415 · bb = 2-digit minor version
416
417 Value may be N/A if the PMem module is not manageable by the
418 software.
419
420 ManufacturerID
421 The manufacturer identifier of the PMem module. This value is
422 presented in big endian format.
423
424 ControllerRevisionID
425 The controller stepping and revision ID retrieved from the
426 controller FW. This field uses a different encoding than
427 SubsystemRevisionID.
428
429 IsNew
430 Whether or not the PMem module is incorporated with the rest of the
431 PMem module in the system. One of:
432
433 · 0: Configured
434
435 · 1: The PMem module requires configuration.
436
437 MemoryCapacity
438 Usable PMem module Memory Mode capacity.
439
440 AppDirectCapacity
441 Usable PMem module App Direct capacity.
442
443 UnconfiguredCapacity
444 PMem module capacity that is inaccessible because it is not mapped
445 into the system physical address space.
446
447 InaccessibleCapacity
448 PMem module capacity that is inaccessible due to:
449
450 · Licensing issue
451
452 · Platform configuration prevents accessing this capacity. For
453 example, MemoryCapacity is configured and available on a PMem
454 module but MemoryMode is not enabled by BIOS.
455
456 ReservedCapacity
457 PMem module capacity reserved for proper alignment.
458
459 AvgPowerLimit
460 If the PMem module firmware power management policy is enabled, the
461 power limit in mW used for average power. Refer to FIS for
462 allowable range and default value.
463
464 MemoryBandwidthBoostFeature
465 Returns if the Memory Bandwidth Boost Feature is currently enabled
466 or not. One of:
467
468 · 0x0: Disabled
469
470 · 0x1: Enabled
471
472 MemoryBandwidthBoostMaxPowerLimit
473 The power limit used for limiting the Memory Bandwidth Boost
474 Feature’s power consumption [mW].
475
476 MemoryBandwidthBoostAveragePowerTimeConstant
477 The value used as a base time window for average power throttle
478 [ms]. This range can be checked in the Max Memory Bandwidth Boost
479 Average Time Constant and Average Power Time Constant Step from the
480 Get Device Characteristics command.
481
482 · Default: 15000 ms
483
484 MaxAveragePowerLimit
485 Maximum average power limit [mW] supported by the PMem module.
486
487 MaxMemoryBandwidthBoostMaxPowerLimit
488 Maximum Memory Bandwidth Boost Power value [mW] that can be set for
489 the PMem module. Will return 0 if unsupported by current FIS.
490
491 MaxAveragePowerTimeConstant
492 This field returns the maximum supported value of the Average Power
493 Time Constant and Average Power Reporting Time constant [ms] that
494 can be set via the Set Power Management Policy and the Optional
495 Configuration Data Policy Commands.
496
497 AveragePowerTimeConstantStep
498 This field returns the increments in milliseconds allowed by the
499 firmware when setting the Average Power Time Constant and Average
500 Power Reporting Time Constant via the Set Power Management Policy
501 and the Optional Configuration Data Policy Commands.
502
503 AveragePower
504 This field returns the average power in milliwatts that each PMem
505 module consumes over the Average Power Reporting Time constant.
506
507 Average12vPower
508 This field returns the 12V average power in milliwatts that each
509 PMem module consumes over the Average Power Reporting Time
510 constant.
511
512 Average1_2vPower
513 This field returns the 1.2V average power in milliwatts that each
514 PMem module consumes over the Average Power Reporting Time
515 constant.
516
517 PackageSparingCapable
518 Whether or not the PMem module supports package sparing. One of:
519
520 · 0: False
521
522 · 1: True
523
524 PackageSparingEnabled
525 Whether or not the PMem module package sparing policy is enabled.
526 One of:
527
528 · 0: Disabled
529
530 · 1: Enabled
531
532 PackageSparesAvailable
533 The number of spare devices available for package sparing.
534
535 LatchedLastShutdownStatus
536 The status of the last shutdown of the PMem module. One or more of:
537
538 · Unknown: The last shutdown status cannot be determined.
539
540 · PM ADR Command Received: Power management ADR command received.
541
542 · PM S3 Received: Power management S3 command received.
543
544 · PM S5 Received: Power management S5 command received.
545
546 · DDRT Power Fail Command Received: DDR power fail command
547 received.
548
549 · PMIC 12V/DDRT 1.2V Power Loss (PLI)
550
551 · PM Warm Reset Received: Power management warm reset received.
552
553 · Thermal Shutdown Received: Thermal shutdown triggered.
554
555 · Controller’s FW State Flush Complete: Flush Completed.
556
557 · Viral Interrupt Received: Viral interrupt received.
558
559 · Surprise Clock Stop Received: Surprise clock stop received.
560
561 · Write Data Flush Complete: Write data flush completed.
562
563 · PM S4 Received: Power management S4 command received.
564
565 · PM Idle Received: Power management idle received.
566
567 · DDRT Surprise Reset Received: Surprise reset received.
568
569 · Extended Flush Complete.
570
571 UnlatchedLastShutdownStatus
572 The status of the last shutdown status of the PMem module. Same
573 fields as the Latched Last Shutdown Status with the only difference
574 that LLS details on a dirty shutdown is logged, even if the Latch
575 System Shutdown Status was not enabled. One or more of:
576
577 · Unknown: The last shutdown status cannot be determined.
578
579 · PM ADR Command: Power management ADR command received.
580
581 · PM S3: Power management S3 command received.
582
583 · PM S5: Power management S5 command received.
584
585 · DDRT Power Fail Command: DDR power fail command received.
586
587 · PMIC 12V/DDRT 1.2V Power Loss (PLI)
588
589 · PM Warm Reset: Power management warm reset received.
590
591 · Thermal Shutdown: Thermal shutdown triggered.
592
593 · Controller’s FW State Flush Complete: Flush Completed.
594
595 · Viral Interrupt: Viral interrupt received.
596
597 · Surprise Clock Stop: Surprise clock stop received.
598
599 · Write Data Flush Complete: Write data flush completed.
600
601 · PM S4: Power management S4 command received.
602
603 · DDRT Surprise Reset: Surprise reset received
604
605 · PM Idle Received: Power management idle received.
606
607 · Extended Flush Complete.
608
609 ThermalThrottleLossPercent
610 The average performance loss percentage due to thermal throttling
611 in current boot of the PMem module.
612
613 LastShutdownTime
614 The time the system was last shutdown.
615
616 ModesSupported
617 A list of the modes supported by the PMem module. Refer to the
618 command Show System Capabilities to determine the modes supported
619 by the platform. One or more of:
620
621 · Memory Mode: PMem modules act as system memory under the
622 control of the operating system. In Memory Mode, any DDR in the
623 platform will act as a cache working in conjunction with the
624 PMem module.
625
626 · App Direct: PMem modules and DDR act as independent memory
627 resources under direct load/store control of the application.
628
629 SecurityCapabilities
630 The security features supported by the PMem module. Zero or more
631 of:
632
633 · Encryption: The PMem module supports persistent memory
634 encryption by setting a passphrase.
635
636 · Erase: The PMem module is erasable.
637
638 MasterPassphraseEnabled
639 This property indicates if master passphrase is enabled. If it is
640 disabled, then it cannot be enabled. One of:
641
642 · 0: Disabled - Cannot be enabled.
643
644 · 1: Enabled - Master passphrase can be changed. Cannot be
645 disabled.
646
647 ConfigurationStatus
648 The status of the PMem module memory configuration. One of:
649
650 · Valid: The configuration is valid.
651
652 · Not Configured: The PMem module has not been configured.
653
654 · Failed - Bad configuration: The configuration is corrupt.
655
656 · Failed - Broken interleave: This PMem module is part of an
657 interleave set that is not complete.
658
659 · Failed - Reverted: The configuration failed and was reverted to
660 the last known good configuration.
661
662 · Failed - Unsupported: The configuration is not compatible with
663 the installed BIOS.
664
665 · Unknown: The configuration cannot be determined.
666
667 SKUViolation
668 The configuration of the PMem module is unsupported due to a
669 license issue. One of:
670
671 · 0: False
672
673 · 1: True
674
675 ARSStatus
676 The address range scrub (ARS) operation status for the PMem module.
677 The status is a reflection of the last requested ARS, but not
678 necessarily within the current platform power cycle. One of:
679
680 · Unknown - The ARS operation status cannot be determined.
681
682 · Not started - An ARS operation has not started.
683
684 · In progress - An ARS operation is currently in progress.
685
686 · Completed - The last ARS operation has completed.
687
688 · Aborted - The last ARS operation was aborted.
689
690 OverwriteStatus
691 The overwrite PMem module operation status for the PMem module. One
692 of:
693
694 · Unknown - The overwrite PMem module operation status cannot be
695 determined. This may occur if the status gets overwritten due
696 to a different long operation running on this PMem module.
697
698 · Not started - An overwrite PMem module operation was not
699 started on the last boot.
700
701 · In progress - An overwrite PMem module operation is currently
702 in progress.
703
704 · Completed - An overwrite PMem module operation completed and a
705 reboot is required to use the PMem module.
706
707 AveragePowerReportingTimeConstantMultiplier
708 The value that is used to multiply the base time value used for
709 average power consumption measurements. Can be set to a value
710 between 0 and 32. The default value is 0.
711
712 AveragePowerReportingTimeConstant
713 The value, in milliseconds, used to determine the time constant for
714 reporting the average power consumption measurements. Can be set to
715 a value between 100 and 12000, by increments of 100. The default
716 value is 1000.
717
718 ViralPolicy
719 Whether viral policies are enabled on the PMem module. One of:
720
721 · 0: Disabled - This is the default.
722
723 · 1: Enabled - The persistent memory on the PMem module will be
724 put into read-only mode if the host operating system software
725 detects an uncorrectable error situation and indicates a viral
726 state in order to prevent the spread of damage.
727
728 ViralState
729 Whether the PMem module is currently viral. One of:
730
731 · 0: Not Viral
732
733 · 1: Viral - The viral policies of the PMem module have switched
734 the persistent memory to read-only mode due to the host
735 operating system software detecting an uncorrectable error
736 situation and indicating a viral state.
737
738 AitDramEnabled
739 If the PMem module AIT DRAM is enabled. One of:
740
741 · 0: Disabled - The device will suffer performance degradation if
742 the AIT DRAM becomes disabled.
743
744 · 1: Enabled
745
746 BootStatus
747 The initialization status of the PMem module as reported by the
748 firmware in the boot status register. One or more of:
749
750 · Unknown - The boot status register cannot be read.
751
752 · Success - No errors were reported during initialization.
753
754 The following statuses indicate that the media is not
755 functional and therefore access to user data and operations
756 that require use of the media will fail.
757
758 · Media Not Ready - The firmware did not complete media training.
759
760 · Media Error - The firmware detected an error during media
761 training.
762
763 · Media Disabled - The firmware disabled the media due to a
764 critical issue.
765
766 The following statuses indicate that communication with the
767 firmware is not functional.
768
769 · FW Assert - The firmware reported an assert during
770 initialization.
771
772 BootStatusRegister
773 The raw hex value of the PMem module Boot Status Register of the
774 PMem module
775
776 LatchSystemShutdownState
777 Status of the latch. Specifies whether the PMem module will latch
778 the SMART Last Shutdown Status and SMART Dirty Shutdown Count.
779
780 · 0: Disabled - This is the default.
781
782 · 1: Enabled
783
784 PreviousPowerCycleLatchSystemShutdownState
785 The status of the latch during the previous power cycle.
786
787 · 0: Disabled - This is the default.
788
789 · 1: Enabled
790
791 ExtendedAdrEnabled
792 Specifies whether extended ADR flow is enabled in the FW.
793
794 · 0: Disabled
795
796 · 1: Enabled
797
798 PpcExtendedAdrEnabled
799 Specifies whether extended ADR flow was enabled in the FW during
800 the last power cycle.
801
802 · 0: Disabled
803
804 · 1: Enabled
805
806 ErrorInjectionEnabled
807 Error injection status.
808
809 · 0: Disabled - This is the default.
810
811 · 1: Enabled
812
813 MediaTemperatureInjectionEnabled
814 Media temperature injection status.
815
816 · 0: Disabled - This is the default.
817
818 · 1: Enabled
819
820 SoftwareTriggersEnabled
821 Software trigger status.
822
823 · 0: Disabled - This is the default.
824
825 · 1: At least one software trigger enabled.
826
827 SoftwareTriggersEnabledDetail
828 Comma separated list of software triggers currently enabled. One or
829 more of:
830
831 · None
832
833 · Package Sparing
834
835 · Fatal Error
836
837 · Percentage Remaining
838
839 · Dirty Shutdown
840
841 PoisonErrorInjectionsCounter
842 This counter is incremented each time the set poison error is
843 successfully executed.
844
845 PoisonErrorClearCounter
846 This counter is incremented each time the clear poison error is
847 successfully executed.
848
849 MediaTemperatureInjectionsCounter
850 This counter is incremented each time the media temperature is
851 injected.
852
853 SoftwareTriggersCounter
854 This counter is incremented each time a software trigger is
855 enabled.
856
857 MaxMediaTemperature
858 The highest die temperature reported in degrees Celsius. This value
859 is persistent through Power Loss as well as not effected by
860 Overwrite PMem module or Media Temperature Error Injection.
861
862 MaxControllerTemperature
863 The highest controller temperature reported in degrees Celsius.
864 This value is persistent through Power Loss as well as not effected
865 by Overwrite PMem module.
866
867 MixedSKU
868 One or more PMem modules in the system have different SKUs. One of:
869
870 · 0: False
871
872 · 1: True - In this case, the host software operates in a
873 read-only mode and does not allow changes to the PMem modules
874 and their associated capacity.
875
876
877
878ipmctl 2020-05-01 IPMCTL-SHOW-DEVICE(1)