1IPMCTL-SHOW-SYSTEM-CAPABILITIES(1)  ipmctl  IPMCTL-SHOW-SYSTEM-CAPABILITIES(1)
2
3
4

NAME

6       ipmctl-show-system-capabilities - Shows the platform supported PMem
7       module capabilities.
8

SYNOPSIS

10           ipmctl show [OPTIONS] -system -capabilities
11

DESCRIPTION

13       Shows the capabilities of the current platform as determined by
14       platform firmware (BIOS) and this application.
15

OPTIONS

17       -a, -all
18           Shows all attributes.
19
20           Note
21           The all and display options are exclusive and may not be used
22           together.
23
24       -d (attributes), -display (attributes)
25           Filters the returned attributes by explicitly specifying a comma
26           separated list of any of the attributes defined in the Return Data
27           section.
28
29           Note
30           The all and display options are exclusive and may not be used
31           together.
32
33       -h, -help
34           Displays help for the command.
35
36       -ddrt
37           Used to specify DDRT as the desired transport protocol for the
38           current invocation of ipmctl.
39
40       -smbus
41           Used to specify SMBUS as the desired transport protocol for the
42           current invocation of ipmctl.
43
44           Note
45           The -ddrt and -smbus options are mutually exclusive and may not be
46           used together.
47
48       -o (text|nvmxml), -output (text|nvmxml)
49           Changes the output format. One of: "text" (default) or "nvmxml".
50
51       -u (B|MB|MiB|GB|GiB|TB| TiB), -units (B|MB|MiB|GB|GiB|TB| TiB)
52           Changes the units that capacities are displayed in for this
53           command. One of: bytes (B), megabytes (MB), mebibytes (MiB),
54           gigabytes (GB), gibibytes (GiB), terabytes (TB) or tebibytes (TiB).
55

EXAMPLES

57       Displays the supported PMem module capabilities
58
59           ipmctl show -system -capabilities
60

RETURN DATA

62       The default behavior is to return the default attributes listed below;
63       the options can be used to expand or restrict the output.
64
65       PlatformConfigSupported
66           (Default) Whether the platform level configuration of PMem modules
67           can be modified with the host software. One of:
68
69           •   0: Changes must be made in the BIOS.
70
71           •   1: The command [Create Memory Allocation Goal] is supported.
72
73       Alignment
74           (Default) Capacity alignment requirement for all memory types as
75           reported by the BIOS.
76
77       AllowedVolatileMode
78           (Default) The volatile mode allowed as determined by BIOS setup.
79           One of:
80
81           •   1LM: One-level volatile mode. All configured PMem module
82               resources on the platform assigned for memory usage are not in
83               use.
84
85           •   2LM: Two-level volatile mode/Memory Mode. PMem module resources
86               configured as memory act as system memory. Any DDR on the
87               platform will act as a cache working in conjunction with the
88               PMem modules.
89
90           •   Unknown: The allowed volatile mode cannot be determined.
91
92       CurrentVolatileMode
93           (Default) The current volatile mode. One of:
94
95           •   1LM: One-level volatile mode. All configured PMem module
96               resources on the platform assigned for memory usage are not in
97               use.
98
99           •   2LM: Two-level volatile mode/Memory Mode. PMem module resources
100               configured as memory act as system memory. Any DDR on the
101               platform will act as a cache working in conjunction with the
102               PMem modules.
103
104           •   Unknown: The current volatile mode cannot be determined.
105
106       AllowedAppDirectMode
107           (Default) The App Direct mode allowed as determined by BIOS setup.
108           One of:
109
110           •   Disabled: App Direct support is currently disabled by the BIOS.
111
112           •   App Direct: App Direct support is currently enabled by the
113               BIOS.
114
115           •   Unknown: The current App Direct support cannot be determined.
116
117       ModesSupported
118           A list of PMem module modes supported by the BIOS. Refer to the
119           command [Show Dimm] to determine the modes supported by the
120           individual PMem modules. At least one of:
121
122           •   1LM: One-level volatile mode. All configured PMem module
123               resources on the platform assigned for memory usage are not in
124               use.
125
126           •   2LM: Two-level volatile mode/Memory Mode. PMem module resources
127               configured as memory act as system memory. Any DDR on the
128               platform will act as a cache working in conjunction with the
129               PMem modules.
130
131           •   App Direct: PMem module resources are under direct load/store
132               control of the application. DDR is unaffected.
133
134           •   Unknown: The current mode cannot be determined.
135
136       SupportedAppDirectSettings
137           The BIOS supported list of App Direct interleave settings in the
138           format:
139
140           •   x[Way] - [(IMCSize) iMC x (ChannelSize) Channel] followed by
141               the input format for the command [Set Preferences]:
142               (ByOne|(IMCSize)_(ChannelSize)).
143
144       RecommendedAppDirectSettings
145           The BIOS recommended list of App Direct interleave settings in the
146           format:
147
148           •   x[Way] - [(IMCSize) iMC x (ChannelSize) Channel] followed by
149               the input format for the command [Set Preferences]:
150               (ByOne|(IMCSize)_(ChannelSize)).
151
152       MinNamespaceSize
153           The minimum allowed namespace size as reported by the driver.
154
155       AppDirectMirrorSupported
156           If the BIOS supports App Direct mirroring. One of:
157
158           •   0: Not supported
159
160           •   1: Supported
161
162       DimmSpareSupported
163           If the BIOS supports PMem module sparing. One of:
164
165           •   0: Not supported
166
167           •   1: Supported
168
169       AppDirectMigrationSupported
170           If the BIOS supports App Direct migration. One of:
171
172           •   0: Not supported
173
174           •   1: Supported
175
176       RenameNamespaceSupported
177           If the host software supports renaming a namespace. One of:
178
179           •   0: Not supported
180
181           •   1: Supported
182
183       GrowAppDirectNamespaceSupported
184           If the host software supports increasing the capacity of an App
185           Direct namespace. One of:
186
187           •   0: Not supported
188
189           •   1: Supported
190
191       ShrinkAppDirectNamespaceSupported
192           If the host software supports decreasing the capacity of an App
193           Direct namespace. One of:
194
195           •   0: Not supported
196
197           •   1: Supported
198
199       InitiateScrubSupported
200           If the platform and host software support initiating an address
201           range scrub on the PMem modules in the system. One of:
202
203           •   0: Not supported
204
205           •   1: Supported
206
207       AdrSupported
208           Whether the platform supports asynchronous DRAM refresh (ADR). One
209           of:
210
211           •   0: Not supported. If ADR is not supported, App Direct data
212               integrity cannot be assured during system interruptions.
213
214           •   1: Supported
215
216       EraseDeviceDataSupported
217           Whether Erase Device Data is supported.
218
219           •   0: Not supported
220
221           •   1: Supported
222
223       EnableDeviceSecuritySupported
224           Whether Enable Device Security is supported.
225
226           •   0: Not supported
227
228           •   1: Supported
229
230       DisableDeviceSecuritySupported
231           Whether Change Device Security property Lockstate = Disabled is
232           supported.
233
234           •   0: Not supported
235
236           •   1: Supported
237
238       UnlockDeviceSecuritySupported
239           Whether Change Device Security property Lockstate = Unlocked is
240           supported.
241
242           •   0: Not supported
243
244           •   1: Supported
245
246       FreezeDeviceSecuritySupported
247           Whether Change Device Security property Lockstate = Frozen is
248           supported.
249
250           •   0: Not supported
251
252           •   1: Supported
253
254       ChangeDevicePassphraseSupported
255           Whether Change Device Passphrase is supported.
256
257           •   0: Not supported
258
259           •   1: Supported
260
261       ChangeMasterPassphraseSupported
262           Whether Change Master Passphrase is supported.
263
264           •   0: Not supported
265
266           •   1: Supported
267
268       MasterEraseDeviceDataSupported
269           Whether Master Erase Device Data is supported.
270
271           •   0: Not supported
272
273           •   1: Supported
274
275
276
277ipmctl                            2023-07-20IPMCTL-SHOW-SYSTEM-CAPABILITIES(1)