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 memory resources in the
82               platform are independently accessible, and not captive of the
83               other resources.
84
85           ·   Memory Mode: PMem modules act as system memory under the
86               control of the operating system. In Memory Mode, any DDR in 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 memory resources in the
96               platform are independently accessible, and not captive of the
97               other resources.
98
99           ·   Memory Mode: PMem modules act as system memory under the
100               control of the operating system. In Memory Mode, any DDR in 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 Device to determine the modes supported by the
120           individual PMem modules. One or more of:
121
122           ·   1LM: One-level volatile mode. All memory resources in the
123               platform are independently accessible, and not captive of the
124               other resources.
125
126           ·   Memory Mode: PMem modules act as system memory under the
127               control of the operating system. In Memory Mode, any DDR in the
128               platform will act as a cache working in conjunction with the
129               PMem modules.
130
131           ·   App Direct: PMem modules and DDR act as independent memory
132               resources under direct load/store control of the application.
133
134       SupportedAppDirectSettings
135           The BIOS supported list of App Direct interleave settings in the
136           format:
137
138           ·   x[Way] - [(IMCSize) iMC x (ChannelSize) Channel] followed by
139               the input format for the command Change Preferences:
140               (ByOne|(IMCSize)_(ChannelSize)).
141
142       RecommendedAppDirectSettings
143           The BIOS recommended list of App Direct interleave settings in the
144           format:
145
146           ·   x[Way] - [(IMCSize) iMC x (ChannelSize) Channel] followed by
147               the input format for the command Change Preferences:
148               (ByOne|(IMCSize)_(ChannelSize)).
149
150       MinNamespaceSize
151           The minimum allowed namespace size as reported by the driver.
152
153       AppDirectMirrorSupported
154           If the BIOS supports App Direct mirroring. One of:
155
156           ·   0: Not supported.
157
158           ·   1: Supported
159
160       DimmSpareSupported
161           If the BIOS supports PMem module sparing. One of:
162
163           ·   0: Not supported
164
165           ·   1: Supported
166
167       AppDirectMigrationSupported
168           If the BIOS supports App Direct migration. One of:
169
170           ·   0: Not supported
171
172           ·   1: Supported
173
174       RenameNamespaceSupported
175           If the host software supports renaming a namespace. One of:
176
177           ·   0: Not supported
178
179           ·   1: Supported
180
181       GrowAppDirectNamespaceSupported
182           If the host software supports increasing the capacity of an App
183           Direct namespace. One of:
184
185           ·   0: Not supported
186
187           ·   1: Supported
188
189       ShrinkAppDirectNamespaceSupported
190           If the host software supports decreasing the capacity of an App
191           Direct namespace. One of:
192
193           ·   0: Not supported
194
195           ·   1: Supported
196
197       InitiateScrubSupported
198           If the platform and host software support initiating an address
199           range scrub on the PMem modules in the system. One of:
200
201           ·   0: Not supported
202
203           ·   1: Supported
204
205       AdrSupported
206           Whether the platform supports asynchronous DRAM refresh (ADR). One
207           of:
208
209           ·   0: Not supported. If ADR is not supported, App Direct data
210               integrity cannot be assured during system interruptions.
211
212           ·   1: Supported
213
214       EraseDeviceDataSupported
215           Whether Erase Device Data is supported.
216
217           ·   0: Not supported
218
219           ·   1: Supported
220
221       EnableDeviceSecuritySupported
222           Whether Enable Device Security is supported.
223
224           ·   0: Not supported
225
226           ·   1: Supported
227
228       DisableDeviceSecuritySupported
229           Whether Change Device Security property Lockstate = Disabled is
230           supported.
231
232           ·   0: Not supported
233
234           ·   1: Supported
235
236       UnlockDeviceSecuritySupported
237           Whether Change Device Security property Lockstate = Unlocked is
238           supported.
239
240           ·   0: Not supported
241
242           ·   1: Supported
243
244       FreezeDeviceSecuritySupported
245           Whether Change Device Security property Lockstate = Frozen is
246           supported.
247
248           ·   0: Not supported
249
250           ·   1: Supported
251
252       ChangeDevicePassphraseSupported
253           Whether Change Device Passphrase is supported.
254
255           ·   0: Not supported
256
257           ·   1: Supported
258
259       ChangeMasterPassphraseSupported
260           Whether Change Master Passphrase is supported.
261
262           ·   0: Not supported
263
264           ·   1: Supported
265
266       MasterEraseDeviceDataSupported
267           Whether Master Erase Device Data is supported.
268
269           ·   0: Not supported
270
271           ·   1: Supported
272
273
274
275ipmctl                            2020-12-03IPMCTL-SHOW-SYSTEM-CAPABILITIES(1)