1IPMCTL-START-DIAGNOSTIC(1)          ipmctl          IPMCTL-START-DIAGNOSTIC(1)
2
3
4

NAME

6       ipmctl-start-diagnostic - Starts a diagnostic test
7

SYNOPSIS

9           ipmctl start [OPTIONS] -diagnostic [TARGETS]
10

DESCRIPTION

12       Starts a diagnostic test.
13

OPTIONS

15       -h, -help
16           Displays help for the command.
17
18       -ddrt
19           Used to specify DDRT as the desired transport protocol for the
20           current invocation of ipmctl.
21
22       -smbus
23           Used to specify SMBUS as the desired transport protocol for the
24           current invocation of ipmctl.
25
26           Note
27           The -ddrt and -smbus options are mutually exclusive and may not be
28           used together.
29
30       -lpmb
31           Used to specify large transport payload size for the current
32           invocation of ipmctl.
33
34       -spmb
35           Used to specify small transport payload size for the current
36           invocation of ipmctl.
37
38           Note
39           The -lpmb and -spmb options are mutually exclusive and may not be
40           used together.
41
42       -o (text|nvmxml), -output (text|nvmxml)
43           Changes the output format. One of: "text" (default) or "nvmxml".
44

TARGETS

46       -diagnostic [Quick|Config|Security|FW]
47           Start a specific test by supplying its name. All tests are run by
48           default. One of:
49
50           •   "Quick" - This test verifies that the PMem module host mailbox
51               is accessible and that basic health indicators can be read and
52               are currently reporting acceptable values.
53
54           •   "Config" - This test verifies that the BIOS platform
55               configuration matches the installed hardware and the platform
56               configuration conform to best known practices.
57
58           •   "Security" - This test verifies that all PMem modules have a
59               consistent security state. It is a best practice to enable
60               security on all PMem modules rather than just some.
61
62           •   "FW" - This test verifies that all PMem modules of a given
63               model have consistent FW installed and other FW modifiable
64               attributes are set in accordance with best practices.
65               Note that the test does not have a means of verifying that the
66               installed FW is the optimal version for a given PMem module
67               model just that it has been consistently applied across the
68               system.
69
70       -dimm [DimmIDS]
71           Starts a diagnostic test on specific PMem modules by optionally
72           supplying one or more comma separated PMem module identifiers. The
73           default is to start the specified tests on all manageable PMem
74           modules. Only valid for the Quick diagnostic test.
75

EXAMPLES

77       Starts all diagnostics.
78
79           ipmctl start -diagnostic
80
81       Starts the quick check diagnostic on PMem module 0x0001.
82
83           ipmctl start -diagnostic Quick -dimm 0x0001
84

LIMITATIONS

86       If a PMem module is unmanageable, then Quick test will report the
87       reason, while Config, Security and FW tests will skip unmanageable PMem
88       modules.
89

RETURN DATA

91       Each diagnostic generates one or more log messages. A successful test
92       generates a single log message per PMem module indicating that no
93       errors were found. A failed test might generate multiple log messages
94       each highlighting a specific error with all the relevant details. Each
95       log contains the following information.
96
97       Test
98           The test name along with overall execution result. One of:
99
100           •   "Quick"
101
102           •   "Config"
103
104           •   "Security"
105
106           •   "FW"
107
108       State
109           The collective result state for each test. One of:
110
111           •   "Ok"
112
113           •   "Warning"
114
115           •   "Failed"
116
117           •   "Aborted"
118
119       Message
120           The message indicates the status of the test. One of:
121
122           •   "Ok"
123
124           •   "Failed"
125
126       SubTestName
127           The subtest name for given Test.
128
129       ┌──────────┬────────────────────────────┐
130       │          │                            │
131       │Test Name │ Valid SubTest Names        │
132       ├──────────┼────────────────────────────┤
133       │          │                            │
134       │Quick     │                            │
135       │          │        •   Manageability   │
136       │          │                            │
137       │          │        •   Boot status     │
138       │          │                            │
139       │          │        •   Health          │
140       ├──────────┼────────────────────────────┤
141       │          │                            │
142       │Config    │                            │
143       │          │        •   PMem module     │
144       │          │            specs           │
145       │          │                            │
146       │          │        •   Duplicate PMem  │
147       │          │            module          │
148       │          │                            │
149       │          │        •   System          │
150       │          │            Capability      │
151       │          │                            │
152       │          │        •   Namespace LSA   │
153       │          │                            │
154       │          │        •   PCD             │
155       ├──────────┼────────────────────────────┤
156       │          │                            │
157       │Security  │                            │
158       │          │        •   Encryption      │
159       │          │            status          │
160       │          │                            │
161       │          │        •   Inconsistency   │
162       ├──────────┼────────────────────────────┤
163       │          │                            │
164       │FW        │                            │
165       │          │        •   FW Consistency  │
166       │          │                            │
167       │          │        •   Viral Policy    │
168       │          │                            │
169       │          │        •   Threshold check │
170       │          │                            │
171       │          │        •   System Time     │
172       └──────────┴────────────────────────────┘
173
174       State
175           The severity of the error for each sub-test displayed with
176           SubTestName. One of:
177
178           •   "Ok"
179
180           •   "Warning"
181
182           •   "Failed"
183
184           •   "Aborted"
185
186       Events are generated as a result of invoking the Start Diagnostics
187       command in order to analyze the Intel® Optane™ PMem module for
188       potential issues.
189
190       Diagnostic events may fall into the following categories:
191
192       •   Quick health diagnostic test event
193
194       •   Platform configuration diagnostic test event
195
196       •   Security diagnostic test event
197
198       •   Firmware consistency and settings diagnostic test event
199
200       Each event includes the following pieces of information:
201
202       •   The severity of the event that occurred. One of:
203
204           •   Informational (Info)
205
206           •   Warning (Warning)
207
208           •   Error (Failed)
209
210           •   Aborted (Aborted)
211
212       •   A unique ID of the item (PMem module UUID, DimmID, NamespaceID,
213           RegionID, etc.) the event refers to.
214
215       •   A detailed description of the event in English.
216
217       The following sections list each of the possible events grouped by
218       category of the event.
219
220   Quick Health Check Events
221       The quick health check diagnostic verifies that the Intel® Optane™ PMem
222       module’s host mailboxes are accessible and that basic health indicators
223       can be read and are currently reporting acceptable values.
224
225       Table 1. Table Quick Health Check Events
226       ┌─────┬──────────┬──────────────────┬─────────────────────────┐
227       │     │          │                  │                         │
228       │Code │ Severity │ Message          │ Arguments               │
229       ├─────┼──────────┼──────────────────┼─────────────────────────┤
230       │     │          │                  │                         │
231       │500  │ Info     │ The quick health │                         │
232       │     │          │ check succeeded. │                         │
233       ├─────┼──────────┼──────────────────┼─────────────────────────┤
234       │     │          │                  │                         │
235       │501  │ Warning  │ The quick health │                         │
236       │     │          │ check detected   │         1. PMem         │
237       │     │          │ that PMem module │            module       │
238       │     │          │ [1] is not       │            Handle       │
239       │     │          │ manageable       │                         │
240       │     │          │ because          │                         │
241       │     │          │ subsystem vendor │            2. Subsystem │
242       │     │          │ ID [2] is not    │            Vendor       │
243       │     │          │ supported. UID:  │            ID           │
244       │     │          │ [3]              │                         │
245       │     │          │                  │         3. PMem         │
246       │     │          │                  │            module       │
247       │     │          │                  │            UID          │
248       ├─────┼──────────┼──────────────────┼─────────────────────────┤
249       │     │          │                  │                         │
250       │502  │ Warning  │ The quick health │                         │
251       │     │          │ check detected   │         1. PMem module  │
252       │     │          │ that PMem module │            Handle       │
253       │     │          │ [1] is not       │                         │
254       │     │          │ manageable       │         2. Subsystem    │
255       │     │          │ because          │            Device ID    │
256       │     │          │ subsystem device │                         │
257       │     │          │ ID [2] is not    │         3. PMem module  │
258       │     │          │ supported. UID:  │            UID          │
259       │     │          │ [3]              │                         │
260       ├─────┼──────────┼──────────────────┼─────────────────────────┤
261       │     │          │                  │                         │
262       │503  │ Warning  │ The quick health │                         │
263       │     │          │ check detected   │         1. PMem module  │
264       │     │          │ that PMem module │            Handle       │
265       │     │          │ [1] is not       │                         │
266       │     │          │ manageable       │         2. FW API       │
267       │     │          │ because firmware │            version      │
268       │     │          │ API version [2]  │                         │
269       │     │          │ is not           │         3. PMem module  │
270       │     │          │ supported. UID:  │            UID          │
271       │     │          │ [3]              │                         │
272       ├─────┼──────────┼──────────────────┼─────────────────────────┤
273       │     │          │                  │                         │
274       │504  │ Warning  │ The quick health │                         │
275       │     │          │ check detected   │         1. PMem module  │
276       │     │          │ that PMem module │            Handle       │
277       │     │          │ [1] is reporting │                         │
278       │     │          │ a bad health     │         2. Actual       │
279       │     │          │ state [2]. UID:  │            Health State │
280       │     │          │ [3]              │                         │
281       │     │          │                  │         3. PMem module  │
282       │     │          │                  │            UID          │
283       ├─────┼──────────┼──────────────────┼─────────────────────────┤
284       │     │          │                  │                         │
285       │505  │ Warning  │ The quick health │                         │
286       │     │          │ check detected   │         1. PMem module  │
287       │     │          │ that PMem module │            Handle       │
288       │     │          │ [1] is reporting │                         │
289       │     │          │ a media          │         2. Actual Media │
290       │     │          │ temperature of   │            Temperature  │
291       │     │          │ [2] C which is   │                         │
292       │     │          │ above the alarm  │         3. Media        │
293       │     │          │ threshold [3] C. │            Temperature  │
294       │     │          │ UID: [4]         │            Threshold    │
295       │     │          │                  │                         │
296       │     │          │                  │         4. PMem module  │
297       │     │          │                  │            UID          │
298       ├─────┼──────────┼──────────────────┼─────────────────────────┤
299       │     │          │                  │                         │
300       │506  │ Warning  │ The quick health │                         │
301       │     │          │ check detected   │         1. PMem module  │
302       │     │          │ that PMem module │            Handle       │
303       │     │          │ [1] is reporting │                         │
304       │     │          │ percentage       │         2. Actual       │
305       │     │          │ remaining at     │            Percentage   │
306       │     │          │ [2]% which is    │            Remaining    │
307       │     │          │ less than the    │                         │
308       │     │          │ alarm threshold  │         3. Percentage   │
309       │     │          │ [3]%. UID: [4]   │            Remaining    │
310       │     │          │                  │            Threshold    │
311       │     │          │                  │                         │
312       │     │          │                  │         4. PMem module  │
313       │     │          │                  │            UID          │
314       ├─────┼──────────┼──────────────────┼─────────────────────────┤
315       │     │          │                  │                         │
316       │507  │ Warning  │ The quick health │                         │
317       │     │          │ check detected   │         1. PMem module  │
318       │     │          │ that PMem module │            Handle       │
319       │     │          │ [1] is reporting │                         │
320       │     │          │ reboot required. │         2. PMem module  │
321       │     │          │ UID: [2]         │            UID          │
322       ├─────┼──────────┼──────────────────┼─────────────────────────┤
323       │     │          │                  │                         │
324       │511  │ Warning  │ The quick health │                         │
325       │     │          │ check detected   │         1. PMem module  │
326       │     │          │ that PMem module │            Handle       │
327       │     │          │ [1] is reporting │                         │
328       │     │          │ a controller     │         2. Actual       │
329       │     │          │ temperature of   │            Controller   │
330       │     │          │ [2] C which is   │            Temperature  │
331       │     │          │ above the alarm  │                         │
332       │     │          │ threshold [3] C. │         3. Controller   │
333       │     │          │ UID: [4]         │            Temperature  │
334       │     │          │                  │            Threshold    │
335       │     │          │                  │                         │
336       │     │          │                  │         4. PMem module  │
337       │     │          │                  │            UID          │
338       ├─────┼──────────┼──────────────────┼─────────────────────────┤
339       │     │          │                  │                         │
340       │513  │ Error    │ The quick health │                         │
341       │     │          │ check detected   │         1. PMem module  │
342       │     │          │ that the boot    │            Handle       │
343       │     │          │ status register  │                         │
344       │     │          │ of PMem module   │         2. PMem module  │
345       │     │          │ [1] is not       │            UID          │
346       │     │          │ readable. UID:   │                         │
347       │     │          │ [2]              │                         │
348       ├─────┼──────────┼──────────────────┼─────────────────────────┤
349       │     │          │                  │                         │
350       │514  │ Error    │ The quick health │                         │
351       │     │          │ check detected   │         1. PMem module  │
352       │     │          │ that the         │            Handle       │
353       │     │          │ firmware on PMem │                         │
354       │     │          │ module [1] is    │         2. PMem module  │
355       │     │          │ reporting that   │            UID          │
356       │     │          │ the media is not │                         │
357       │     │          │ ready. UID: [2]  │                         │
358       ├─────┼──────────┼──────────────────┼─────────────────────────┤
359       │     │          │                  │                         │
360       │515  │ Error    │ The quick health │                         │
361       │     │          │ check detected   │         1. PMem module  │
362       │     │          │ that the         │            Handle       │
363       │     │          │ firmware on PMem │                         │
364       │     │          │ module [1] is    │         2. PMem module  │
365       │     │          │ reporting an     │            UID          │
366       │     │          │ error in the     │                         │
367       │     │          │ media. UID: [2]  │                         │
368       ├─────┼──────────┼──────────────────┼─────────────────────────┤
369       │     │          │                  │                         │
370       │519  │ Error    │ The quick health │                         │
371       │     │          │ check detected   │         1. PMem module  │
372       │     │          │ that PMem module │            Handle       │
373       │     │          │ [1] failed to    │                         │
374       │     │          │ initialize BIOS  │         2. PMem module  │
375       │     │          │ POST testing.    │            UID          │
376       │     │          │ UID: [2]         │                         │
377       ├─────┼──────────┼──────────────────┼─────────────────────────┤
378       │     │          │                  │                         │
379       │520  │ Error    │ The quick health │                         │
380       │     │          │ check detected   │         1. PMem module  │
381       │     │          │ that the         │            Handle       │
382       │     │          │ firmware on PMem │                         │
383       │     │          │ module [1] has   │         2. Major        │
384       │     │          │ not initialized  │            checkpoint : │
385       │     │          │ successfully.    │            Minor        │
386       │     │          │ The last known   │            checkpoint   │
387       │     │          │ Major:Minor      │            in Boot      │
388       │     │          │ Checkpoint is    │            Status       │
389       │     │          │ [2]. UID: [3]    │            Register     │
390       │     │          │                  │                         │
391       │     │          │                  │         3. PMem module  │
392       │     │          │                  │            UID          │
393       ├─────┼──────────┼──────────────────┼─────────────────────────┤
394       │     │          │                  │                         │
395       │523  │ Error    │ The quick health │                         │
396       │     │          │ check detected   │         1. PMem module  │
397       │     │          │ that PMem module │            Handle       │
398       │     │          │ [1] is reporting │                         │
399       │     │          │ a viral state.   │         2. PMem module  │
400       │     │          │ The PMem module  │            UID          │
401       │     │          │ is now           │                         │
402       │     │          │ read-only. UID:  │                         │
403       │     │          │ [2]              │                         │
404       ├─────┼──────────┼──────────────────┼─────────────────────────┤
405       │     │          │                  │                         │
406       │529  │ Warning  │ The quick health │                         │
407       │     │          │ check detected   │         1. PMem module  │
408       │     │          │ that PMem module │            Handle       │
409       │     │          │ [1] is reporting │                         │
410       │     │          │ that it has no   │         2. PMem module  │
411       │     │          │ package spares   │            UID          │
412       │     │          │ available. UID:  │                         │
413       │     │          │ [2]              │                         │
414       ├─────┼──────────┼──────────────────┼─────────────────────────┤
415       │     │          │                  │                         │
416       │530  │ Info     │ The quick health │                         │
417       │     │          │ check detected   │         1. PMem module  │
418       │     │          │ that the         │            Handle       │
419       │     │          │ firmware on PMem │                         │
420       │     │          │ module [1]       │         2. PMem module  │
421       │     │          │ experienced an   │            UID          │
422       │     │          │ unsafe shutdown  │                         │
423       │     │          │ before its       │                         │
424       │     │          │ latest restart.  │                         │
425       │     │          │ UID: [2]         │                         │
426       ├─────┼──────────┼──────────────────┼─────────────────────────┤
427       │     │          │                  │                         │
428       │533  │ Error    │ The quick health │                         │
429       │     │          │ check detected   │         1. PMem module  │
430       │     │          │ that the         │            Handle       │
431       │     │          │ firmware on PMem │                         │
432       │     │          │ module [1] is    │         2. PMem module  │
433       │     │          │ reporting that   │            UID          │
434       │     │          │ the AIT DRAM is  │                         │
435       │     │          │ not ready. UID:  │                         │
436       │     │          │ [2]              │                         │
437       ├─────┼──────────┼──────────────────┼─────────────────────────┤
438       │     │          │                  │                         │
439       │534  │ Error    │ The quick health │                         │
440       │     │          │ check detected   │         1. PMem module  │
441       │     │          │ that the         │            Handle       │
442       │     │          │ firmware on PMem │                         │
443       │     │          │ module [1] is    │         2. PMem module  │
444       │     │          │ reporting that   │            UID          │
445       │     │          │ the media is     │                         │
446       │     │          │ disabled. UID:   │                         │
447       │     │          │ [2]              │                         │
448       ├─────┼──────────┼──────────────────┼─────────────────────────┤
449       │     │          │                  │                         │
450       │535  │ Error    │ The quick health │                         │
451       │     │          │ check detected   │         1. PMem module  │
452       │     │          │ that the         │            Handle       │
453       │     │          │ firmware on PMem │                         │
454       │     │          │ module [1] is    │         2. PMem module  │
455       │     │          │ reporting that   │            UID          │
456       │     │          │ the AIT DRAM is  │                         │
457       │     │          │ disabled. UID:   │                         │
458       │     │          │ [2]              │                         │
459       ├─────┼──────────┼──────────────────┼─────────────────────────┤
460       │     │          │                  │                         │
461       │536  │ Error    │ The quick health │                         │
462       │     │          │ check detected   │         1. PMem module  │
463       │     │          │ that the         │            Handle       │
464       │     │          │ firmware on PMem │                         │
465       │     │          │ module [1]       │         2. PMem module  │
466       │     │          │ failed to load   │            UID          │
467       │     │          │ successfully.    │                         │
468       │     │          │ UID: [2]         │                         │
469       ├─────┼──────────┼──────────────────┼─────────────────────────┤
470       │     │          │                  │                         │
471       │538  │ Error    │ PMem module [1]  │                         │
472       │     │          │ is reporting     │         1. PMem module  │
473       │     │          │ that the DDRT IO │            Handle       │
474       │     │          │ Init is not      │                         │
475       │     │          │ complete. UID:   │         2. PMem module  │
476       │     │          │ [2]              │            UID          │
477       ├─────┼──────────┼──────────────────┼─────────────────────────┤
478       │     │          │                  │                         │
479       │539  │ Error    │ PMem module [1]  │                         │
480       │     │          │ is reporting     │         1. PMem module  │
481       │     │          │ that the mailbox │            Handle       │
482       │     │          │ interface is not │                         │
483       │     │          │ ready. UID: [2]  │         2. PMem module  │
484       │     │          │                  │            UID          │
485       ├─────┼──────────┼──────────────────┼─────────────────────────┤
486       │     │          │                  │                         │
487       │540  │ Error    │ An internal      │                         │
488       │     │          │ error caused the │         1. PMem module  │
489       │     │          │ quick health     │            Handle       │
490       │     │          │ check to abort   │                         │
491       │     │          │ on PMem module   │         2. PMem module  │
492       │     │          │ [1]. UID: [2]    │            UID          │
493       ├─────┼──────────┼──────────────────┼─────────────────────────┤
494       │     │          │                  │                         │
495       │541  │ Error    │ The quick health │                         │
496       │     │          │ check detected   │         1. PMem module  │
497       │     │          │ that PMem module │            Handle       │
498       │     │          │ [1] is busy.     │                         │
499       │     │          │ UID: [2]         │         2. PMem module  │
500       │     │          │                  │            UID          │
501       ├─────┼──────────┼──────────────────┼─────────────────────────┤
502       │     │          │                  │                         │
503       │542  │ Error    │ The quick health │                         │
504       │     │          │ check detected   │         1. PMem module  │
505       │     │          │ that the         │            Handle       │
506       │     │          │ platform FW did  │                         │
507       │     │          │ not map a region │         2. PMem module  │
508       │     │          │ to SPA on PMem   │            UID          │
509       │     │          │ module [1]. ACPI │                         │
510       │     │          │ NFIT NVPMem      │                         │
511       │     │          │ module State     │                         │
512       │     │          │ Flags Error Bit  │                         │
513       │     │          │ 6 Set. UID: [2]  │                         │
514       ├─────┼──────────┼──────────────────┼─────────────────────────┤
515       │     │          │                  │                         │
516       │543  │ Error    │ The quick health │                         │
517       │     │          │ check detected   │         1. PMem module  │
518       │     │          │ that PMem module │            Handle       │
519       │     │          │ [1] DDRT         │                         │
520       │     │          │ Training is not  │         2. PMem module  │
521       │     │          │ complete/failed. │            UID          │
522       │     │          │ UID: [2]         │                         │
523       ├─────┼──────────┼──────────────────┼─────────────────────────┤
524       │     │          │                  │                         │
525       │544  │ Error    │ PMem module [1]  │                         │
526       │     │          │ is reporting     │         1. PMem module  │
527       │     │          │ that the DDRT IO │            Handle       │
528       │     │          │ Init is not      │                         │
529       │     │          │ started. UID:    │         2. PMem module  │
530       │     │          │ [2]              │            UID          │
531       ├─────┼──────────┼──────────────────┼─────────────────────────┤
532       │     │          │                  │                         │
533       │545  │ Error    │ The quick health │                         │
534       │     │          │ check detected   │         1. PMem module  │
535       │     │          │ that the ROM on  │            Handle       │
536       │     │          │ PMem module [1]  │                         │
537       │     │          │ has failed to    │         2. Major        │
538       │     │          │ complete         │            checkpoint : │
539       │     │          │ initialization,  │            Minor        │
540       │     │          │ last known       │            checkpoint   │
541       │     │          │ Major:Minor      │            in Boot      │
542       │     │          │ Checkpoint is    │            Status       │
543       │     │          │ [2].             │            Register     │
544       │     │          │                  │                         │
545       │     │          │                  │         3. PMem module  │
546       │     │          │                  │            UID          │
547       └─────┴──────────┴──────────────────┴─────────────────────────┘
548
549   Platform Configuration Check Events
550       This diagnostic test group verifies that the BIOS platform
551       configuration matches the installed hardware and the platform
552       configuration conforms to best known practices.
553
554       Table 2. Table Platform Configuration Check Events
555       ┌─────┬──────────┬───────────────────────────────┬──────────────────────────┐
556       │     │          │                               │                          │
557       │Code │ Severity │ Message                       │ Arguments                │
558       ├─────┼──────────┼───────────────────────────────┼──────────────────────────┤
559       │     │          │                               │                          │
560       │600  │ Info     │ The platform                  │                          │
561       │     │          │ configuration                 │                          │
562       │     │          │ check succeeded.              │                          │
563       ├─────┼──────────┼───────────────────────────────┼──────────────────────────┤
564       │     │          │                               │                          │
565       │601  │ Info     │ The platform                  │                          │
566       │     │          │ configuration                 │                          │
567       │     │          │ check detected                │                          │
568       │     │          │ that there are                │                          │
569       │     │          │ no manageable                 │                          │
570       │     │          │ PMem modules.                 │                          │
571       ├─────┼──────────┼───────────────────────────────┼──────────────────────────┤
572       │     │          │                               │                          │
573       │606  │ Info     │ The platform                  │                          │
574       │     │          │ configuration                 │         1. PMem          │
575       │     │          │ check detected                │            module        │
576       │     │          │ that PMem module              │            Handle        │
577       │     │          │ [1] is not                    │                          │
578       │     │          │ configured. UID:              │         2. PMem          │
579       │     │          │ [2]                           │            module        │
580       │     │          │                               │            UID           │
581       ├─────┼──────────┼───────────────────────────────┼──────────────────────────┤
582       │     │          │                               │                          │
583       │608  │ Error    │ The platform                  │                          │
584       │     │          │ configuration                 │         1. Number        │
585       │     │          │ check detected                │            of            │
586       │     │          │ [1] PMem modules              │            PMem          │
587       │     │          │ installed on the              │            modules       │
588       │     │          │ platform with                 │            with          │
589       │     │          │ the same serial               │            duplicate     │
590       │     │          │ number [2].                   │            serial        │
591       │     │          │                               │            numbers.      │
592       │     │          │                               │                          │
593       │     │          │                               │         2. The           │
594       │     │          │                               │            duplicate     │
595       │     │          │                               │            serial        │
596       │     │          │                               │            number        │
597       ├─────┼──────────┼───────────────────────────────┼──────────────────────────┤
598       │     │          │                               │                          │
599       │609  │ Info     │ The platform                  │                          │
600       │     │          │ configuration                 │         1. PMem          │
601       │     │          │ check detected                │            module        │
602       │     │          │ that PMem module              │            Handle        │
603       │     │          │ [1] has a goal                │                          │
604       │     │          │ configuration                 │         2. PMem          │
605       │     │          │ that has not yet              │            module        │
606       │     │          │ been applied. A               │            UID           │
607       │     │          │ system reboot is              │                          │
608       │     │          │ required for the              │                          │
609       │     │          │ new                           │                          │
610       │     │          │ configuration to              │                          │
611       │     │          │ take effect.                  │                          │
612       │     │          │ UID: [2]                      │                          │
613       ├─────┼──────────┼───────────────────────────────┼──────────────────────────┤
614       │     │          │                               │                          │
615       │618  │ Error    │ The platform                  │                          │
616       │     │          │ configuration                 │         1. PMem          │
617       │     │          │ check detected                │            module        │
618       │     │          │ that a PMem                   │            handle in     │
619       │     │          │ module with                   │            the           │
620       │     │          │ physical ID [1]               │            SMBIOS        │
621       │     │          │ is present in                 │            table         │
622       │     │          │ the system but                │                          │
623       │     │          │ failed to                     │         2. PMem          │
624       │     │          │ initialize. UID:              │            module        │
625       │     │          │ [2]                           │            UID           │
626       ├─────┼──────────┼───────────────────────────────┼──────────────────────────┤
627       │     │          │                               │                          │
628       │621  │ Error    │ The platform                  │                          │
629       │     │          │ configuration                 │         1. PMem          │
630       │     │          │ check detected                │            module        │
631       │     │          │ PCD contains                  │            Handle        │
632       │     │          │ invalid data on               │                          │
633       │     │          │ PMem module [1].              │         2. PMem          │
634       │     │          │ UID: [2]                      │            module        │
635       │     │          │                               │            UID           │
636       ├─────┼──────────┼───────────────────────────────┼──────────────────────────┤
637       │     │          │                               │                          │
638       │622  │ Error    │ The platform                  │                          │
639       │     │          │ configuration                 │                          │
640       │     │          │ check was unable              │                          │
641       │     │          │ to retrieve the               │                          │
642       │     │          │ namespace                     │                          │
643       │     │          │ information.                  │                          │
644       ├─────┼──────────┼───────────────────────────────┼──────────────────────────┤
645       │     │          │                               │                          │
646       │623  │ Warning  │ The platform                  │                          │
647       │     │          │ configuration                 │                          │
648       │     │          │ check detected                │                          │
649       │     │          │ that the BIOS                 │                          │
650       │     │          │ settings do not               │                          │
651       │     │          │ currently allow               │                          │
652       │     │          │ memory                        │                          │
653       │     │          │ provisioning                  │                          │
654       │     │          │ from this                     │                          │
655       │     │          │ software.                     │                          │
656       ├─────┼──────────┼───────────────────────────────┼──────────────────────────┤
657       │     │          │                               │                          │
658       │624  │ Error    │ The platform                  │                          │
659       │     │          │ configuration                 │         1. PMem          │
660       │     │          │ check detected                │            module        │
661       │     │          │ that the BIOS                 │            Handle        │
662       │     │          │ could not apply               │                          │
663       │     │          │ the                           │                          │
664       │     │          │ configuration                 │            2. Validation │
665       │     │          │ goal on PMem                  │            Status        │
666       │     │          │ module [1]                    │                          │
667       │     │          │ because of                    │         3. Text          │
668       │     │          │ errors in the                 │            error         │
669       │     │          │ goal data. The                │            code          │
670       │     │          │ detailed status               │            corresponding │
671       │     │          │ is COUT table                 │            to the        │
672       │     │          │ status: [2] [3],              │            status        │
673       │     │          │ Partition change              │            code          │
674       │     │          │ table status:                 │                          │
675       │     │          │ [4], Interleave               │         4. Partition     │
676       │     │          │ change table 1                │            Size          │
677       │     │          │ status: [5],                  │            Change        │
678       │     │          │ Interleave                    │            Status        │
679       │     │          │ change table 2                │                          │
680       │     │          │ status: [6].                  │                          │
681       │     │          │                               │            5. Interleave │
682       │     │          │                               │            Change        │
683       │     │          │                               │            Status        │
684       │     │          │                               │                          │
685       │     │          │                               │                          │
686       │     │          │                               │            6. Interleave │
687       │     │          │                               │            Change        │
688       │     │          │                               │            Status        │
689       ├─────┼──────────┼───────────────────────────────┼──────────────────────────┤
690       │     │          │                               │                          │
691       │625  │ Error    │ The platform                  │                          │
692       │     │          │ configuration                 │         1. PMem module   │
693       │     │          │ check detected                │            Handle        │
694       │     │          │ that the BIOS                 │                          │
695       │     │          │ could not apply               │         2. Validation    │
696       │     │          │ the                           │            Status        │
697       │     │          │ configuration                 │                          │
698       │     │          │ goal on PMem                  │         3. Text error    │
699       │     │          │ module [1]                    │            code          │
700       │     │          │ because the                   │            corresponding │
701       │     │          │ system has                    │            to the status │
702       │     │          │ insufficient                  │            code          │
703       │     │          │ resources. The                │                          │
704       │     │          │ detailed status               │         4. Partition     │
705       │     │          │ is COUT table                 │            Size Change   │
706       │     │          │ status: [2] [3],              │            Status        │
707       │     │          │ Partition change              │                          │
708       │     │          │ table status:                 │         5. Interleave    │
709       │     │          │ [4], Interleave               │            Change Status │
710       │     │          │ change table 1                │                          │
711       │     │          │ status: [5],                  │         6. Interleave    │
712       │     │          │ Interleave                    │            Change Status │
713       │     │          │ change table 2                │                          │
714       │     │          │ status: [6].                  │                          │
715       ├─────┼──────────┼───────────────────────────────┼──────────────────────────┤
716       │     │          │                               │                          │
717       │626  │ Error    │ The platform                  │                          │
718       │     │          │ configuration                 │         1. PMem module   │
719       │     │          │ check detected                │            Handle        │
720       │     │          │ that the BIOS                 │                          │
721       │     │          │ could not apply               │         2. Validation    │
722       │     │          │ the                           │            Status        │
723       │     │          │ configuration                 │                          │
724       │     │          │ goal on PMem                  │         3. Text error    │
725       │     │          │ module [1]                    │            code          │
726       │     │          │ because of a                  │            corresponding │
727       │     │          │ firmware error.               │            to the status │
728       │     │          │ The detailed                  │            code          │
729       │     │          │ status is COUT                │                          │
730       │     │          │ table status:                 │         4. Partition     │
731       │     │          │ [2] [3],                      │            Size Change   │
732       │     │          │ Partition change              │            Status        │
733       │     │          │ table status:                 │                          │
734       │     │          │ [4], Interleave               │         5. Interleave    │
735       │     │          │ change table 1                │            Change Status │
736       │     │          │ status: [5],                  │                          │
737       │     │          │ Interleave                    │         6. Interleave    │
738       │     │          │ change table 2                │            Change Status │
739       │     │          │ status: [6].                  │                          │
740       ├─────┼──────────┼───────────────────────────────┼──────────────────────────┤
741       │     │          │                               │                          │
742       │627  │ Error    │ The platform                  │                          │
743       │     │          │ configuration                 │         1. PMem module   │
744       │     │          │ check detected                │            Handle        │
745       │     │          │ that the BIOS                 │                          │
746       │     │          │ could not apply               │         2. Validation    │
747       │     │          │ the                           │            Status        │
748       │     │          │ configuration                 │                          │
749       │     │          │ goal on PMem                  │         3. Text error    │
750       │     │          │ module [1] for                │            code          │
751       │     │          │ an unknown                    │            corresponding │
752       │     │          │ reason. The                   │            to the status │
753       │     │          │ detailed status               │            code          │
754       │     │          │ is COUT table                 │                          │
755       │     │          │ status: [2] [3],              │         4. Partition     │
756       │     │          │ Partition change              │            Size Change   │
757       │     │          │ table status:                 │            Status        │
758       │     │          │ [4], Interleave               │                          │
759       │     │          │ change table 1                │         5. Interleave    │
760       │     │          │ status: [5],                  │            Change Status │
761       │     │          │ Interleave                    │                          │
762       │     │          │ change table 2                │         6. Interleave    │
763       │     │          │ status: [6].                  │            Change Status │
764       ├─────┼──────────┼───────────────────────────────┼──────────────────────────┤
765       │     │          │                               │                          │
766       │628  │ Error    │ The platform                  │                          │
767       │     │          │ configuration                 │         1. Interleave    │
768       │     │          │ check detected                │            set index ID  │
769       │     │          │ that interleave               │                          │
770       │     │          │ set [1] is                    │         2. List of moved │
771       │     │          │ broken because                │            PMem modules. │
772       │     │          │ the PMem modules              │                          │
773       │     │          │ were moved [2].               │                          │
774       ├─────┼──────────┼───────────────────────────────┼──────────────────────────┤
775       │     │          │                               │                          │
776       │629  │ Error    │ The platform                  │                          │
777       │     │          │ configuration                 │                          │
778       │     │          │ check detected                │                          │
779       │     │          │ that the                      │                          │
780       │     │          │ platform does                 │                          │
781       │     │          │ not support ADR               │                          │
782       │     │          │ and therefore                 │                          │
783       │     │          │ data integrity                │                          │
784       │     │          │ is not                        │                          │
785       │     │          │ guaranteed on                 │                          │
786       │     │          │ the PMem                      │                          │
787       │     │          │ modules.                      │                          │
788       ├─────┼──────────┼───────────────────────────────┼──────────────────────────┤
789       │     │          │                               │                          │
790       │630  │ Error    │ An internal                   │                          │
791       │     │          │ error caused the              │                          │
792       │     │          │ platform                      │                          │
793       │     │          │ configuration                 │                          │
794       │     │          │ check to abort.               │                          │
795       ├─────┼──────────┼───────────────────────────────┼──────────────────────────┤
796       │     │          │                               │                          │
797       │631  │ Error    │ The platform                  │                          │
798       │     │          │ configuration                 │         1. Interleave    │
799       │     │          │ check detected                │            set index ID  │
800       │     │          │ that interleave               │                          │
801       │     │          │ set [1] is                    │         2. PMem module   │
802       │     │          │ broken because                │            UID           │
803       │     │          │ the PMem module               │                          │
804       │     │          │ with UID: [2] is              │         3. Location ID   │
805       │     │          │ missing from                  │                          │
806       │     │          │ location                      │                          │
807       │     │          │ (Socket-Die-iMC-Channel-Slot) │                          │
808       │     │          │ [3].                          │                          │
809       ├─────┼──────────┼───────────────────────────────┼──────────────────────────┤
810       │     │          │                               │                          │
811       │632  │ Error    │ The platform configuration    │                          │
812       │     │          │ check detected that           │         1. Interleave    │
813       │     │          │ interleave set [1] is broken  │            set index ID  │
814       │     │          │ because the PMem module with  │                          │
815       │     │          │ UID: [2] is misplaced. It is  │         2. PMem module   │
816       │     │          │ currently in location         │            UID           │
817       │     │          │ (Socket-Die-iMC-Channel-Slot) │                          │
818       │     │          │ [3] and should be moved to    │         3. Location ID   │
819       │     │          │ (Socket-Die-iMC-Channel-Slot) │                          │
820       │     │          │ [4].                          │         4. Location ID   │
821       ├─────┼──────────┼───────────────────────────────┼──────────────────────────┤
822       │     │          │                               │                          │
823       │633  │ Error    │ The platform configuration    │                          │
824       │     │          │ check detected that the BIOS  │         1. PMem module   │
825       │     │          │ could not fully map memory on │            Handle        │
826       │     │          │ PMem module [1] because of an │                          │
827       │     │          │ error in current              │         2. Current       │
828       │     │          │ configuration. The detailed   │            Configuration │
829       │     │          │ status is CCUR table status:  │            Status        │
830       │     │          │ [2] [3].                      │                          │
831       │     │          │                               │         3. Text error    │
832       │     │          │                               │            code          │
833       │     │          │                               │            corresponding │
834       │     │          │                               │            to the status │
835       │     │          │                               │            code          │
836       └─────┴──────────┴───────────────────────────────┴──────────────────────────┘
837
838   Security Check Events
839       The security check diagnostic test group verifies that all Intel®
840       Optane™ PMem modules have a consistent security state.
841
842       Table 3. Table Security Check Events
843       ┌─────┬──────────┬──────────────────┬──────────────────────┐
844       │     │          │                  │                      │
845       │Code │ Severity │ Message          │ Arguments            │
846       ├─────┼──────────┼──────────────────┼──────────────────────┤
847       │     │          │                  │                      │
848       │800  │ Info     │ The security     │                      │
849       │     │          │ check succeeded. │                      │
850       ├─────┼──────────┼──────────────────┼──────────────────────┤
851       │     │          │                  │                      │
852       │801  │ Info     │ The security     │                      │
853       │     │          │ check detected   │                      │
854       │     │          │ that there are   │                      │
855       │     │          │ no manageable    │                      │
856       │     │          │ PMem modules.    │                      │
857       ├─────┼──────────┼──────────────────┼──────────────────────┤
858       │     │          │                  │                      │
859       │802  │ Warning  │ The security     │                      │
860       │     │          │ check detected   │         1. A         │
861       │     │          │ that security    │            comma     │
862       │     │          │ settings are     │            separated │
863       │     │          │ inconsistent     │            list      │
864       │     │          │ [1].             │            of        │
865       │     │          │                  │            the       │
866       │     │          │                  │            number    │
867       │     │          │                  │            of        │
868       │     │          │                  │            PMem      │
869       │     │          │                  │            modules   │
870       │     │          │                  │            in        │
871       │     │          │                  │            each      │
872       │     │          │                  │            security  │
873       │     │          │                  │            state     │
874       ├─────┼──────────┼──────────────────┼──────────────────────┤
875       │     │          │                  │                      │
876       │804  │ Info     │ The security     │                      │
877       │     │          │ check detected   │                      │
878       │     │          │ that security is │                      │
879       │     │          │ not supported on │                      │
880       │     │          │ all PMem         │                      │
881       │     │          │ modules.         │                      │
882       ├─────┼──────────┼──────────────────┼──────────────────────┤
883       │     │          │                  │                      │
884       │805  │ Error    │ An internal      │                      │
885       │     │          │ error caused the │                      │
886       │     │          │ security check   │                      │
887       │     │          │ to abort.        │                      │
888       └─────┴──────────┴──────────────────┴──────────────────────┘
889
890   Firmware Consistency and Settings Check Events
891       This test group verifies that all PMem modules of a given subsystem
892       device ID have consistent FW installed and other FW modifiable
893       attributes are set in accordance with best practices.
894
895       Table 4. Table Firmware Consistency and Settings Check Events
896       ┌─────┬──────────┬──────────────────┬─────────────────────────┐
897       │     │          │                  │                         │
898       │Code │ Severity │ Message          │ Arguments               │
899       ├─────┼──────────┼──────────────────┼─────────────────────────┤
900       │     │          │                  │                         │
901       │900  │ Info     │ The firmware     │                         │
902       │     │          │ consistency and  │                         │
903       │     │          │ settings check   │                         │
904       │     │          │ succeeded.       │                         │
905       ├─────┼──────────┼──────────────────┼─────────────────────────┤
906       │     │          │                  │                         │
907       │901  │ Info     │ The firmware     │                         │
908       │     │          │ consistency and  │                         │
909       │     │          │ settings check   │                         │
910       │     │          │ detected that    │                         │
911       │     │          │ there are no     │                         │
912       │     │          │ manageable PMem  │                         │
913       │     │          │ modules.         │                         │
914       ├─────┼──────────┼──────────────────┼─────────────────────────┤
915       │     │          │                  │                         │
916       │902  │ Warning  │ The firmware     │                         │
917       │     │          │ consistency and  │         1. Comma        │
918       │     │          │ settings check   │            separated    │
919       │     │          │ detected that    │            list         │
920       │     │          │ firmware version │            of           │
921       │     │          │ on PMem modules  │            PMem         │
922       │     │          │ [1] with         │            module       │
923       │     │          │ subsystem device │            UIDs         │
924       │     │          │ ID [2] is        │                         │
925       │     │          │ non-optimal,     │                         │
926       │     │          │ preferred        │            2. Subsystem │
927       │     │          │ version is [3].  │            device       │
928       │     │          │                  │            ID           │
929       │     │          │                  │                         │
930       │     │          │                  │                         │
931       │     │          │                  │            3. Preferred │
932       │     │          │                  │            firmware     │
933       │     │          │                  │            version      │
934       ├─────┼──────────┼──────────────────┼─────────────────────────┤
935       │     │          │                  │                         │
936       │903  │ Warning  │ The firmware     │                         │
937       │     │          │ consistency and  │         1. PMem module  │
938       │     │          │ settings check   │            Handle       │
939       │     │          │ detected that    │                         │
940       │     │          │ PMem module [1]  │         2. Current      │
941       │     │          │ is reporting a   │            media        │
942       │     │          │ non-critical     │            temperature  │
943       │     │          │ media            │            threshold    │
944       │     │          │ temperature      │                         │
945       │     │          │ threshold of [2] │         3. Fatal media  │
946       │     │          │ C which is above │            temperature  │
947       │     │          │ the fatal        │            threshold    │
948       │     │          │ threshold [3] C. │                         │
949       │     │          │ UID: [4]         │         4. PMem module  │
950       │     │          │                  │            UID          │
951       ├─────┼──────────┼──────────────────┼─────────────────────────┤
952       │     │          │                  │                         │
953       │904  │ Warning  │ The firmware     │                         │
954       │     │          │ consistency and  │         1. PMem module  │
955       │     │          │ settings check   │            Handle       │
956       │     │          │ detected that    │                         │
957       │     │          │ PMem module [1]  │         2. Current      │
958       │     │          │ is reporting a   │            controller   │
959       │     │          │ non-critical     │            temperature  │
960       │     │          │ controller       │            threshold    │
961       │     │          │ temperature      │                         │
962       │     │          │ threshold of [2] │         3. Fatal        │
963       │     │          │ C which is above │            controller   │
964       │     │          │ the fatal        │            temperature  │
965       │     │          │ threshold [3] C. │            threshold    │
966       │     │          │ UID: [4]         │                         │
967       │     │          │                  │         4. PMem module  │
968       │     │          │                  │            UID          │
969       ├─────┼──────────┼──────────────────┼─────────────────────────┤
970       │     │          │                  │                         │
971       │905  │ Warning  │ The firmware     │                         │
972       │     │          │ consistency and  │         1. PMem module  │
973       │     │          │ settings check   │            Handle       │
974       │     │          │ detected that    │                         │
975       │     │          │ PMem module [1]  │         2. Current      │
976       │     │          │ is reporting a   │            percentage   │
977       │     │          │ percentage       │            remaining    │
978       │     │          │ remaining of     │            threshold    │
979       │     │          │ [2]% which is    │                         │
980       │     │          │ below the        │         3. Recommended  │
981       │     │          │ recommended      │            percentage   │
982       │     │          │ threshold [3]%.  │            remaining    │
983       │     │          │ UID: [4]         │            threshold    │
984       │     │          │                  │                         │
985       │     │          │                  │         4. PMem module  │
986       │     │          │                  │            UID          │
987       ├─────┼──────────┼──────────────────┼─────────────────────────┤
988       │     │          │                  │                         │
989       │906  │ Warning  │ The firmware     │                         │
990       │     │          │ consistency and  │                         │
991       │     │          │ settings check   │                         │
992       │     │          │ detected that    │                         │
993       │     │          │ PMem modules     │                         │
994       │     │          │ have             │                         │
995       │     │          │ inconsistent     │                         │
996       │     │          │ viral policy     │                         │
997       │     │          │ settings.        │                         │
998       ├─────┼──────────┼──────────────────┼─────────────────────────┤
999       │     │          │                  │                         │
1000       │910  │ Error    │ An internal      │                         │
1001       │     │          │ error caused the │                         │
1002       │     │          │ firmware         │                         │
1003       │     │          │ consistency and  │                         │
1004       │     │          │ settings check   │                         │
1005       │     │          │ to abort.        │                         │
1006       ├─────┼──────────┼──────────────────┼─────────────────────────┤
1007       │     │          │                  │                         │
1008       │911  │ Warning  │ The firmware     │                         │
1009       │     │          │ consistency and  │                         │
1010       │     │          │ settings check   │                         │
1011       │     │          │ detected that    │                         │
1012       │     │          │ PMem modules     │                         │
1013       │     │          │ have             │                         │
1014       │     │          │ inconsistent     │                         │
1015       │     │          │ first fast       │                         │
1016       │     │          │ refresh          │                         │
1017       │     │          │ settings.        │                         │
1018       └─────┴──────────┴──────────────────┴─────────────────────────┘
1019
1020
1021
1022ipmctl                            2023-01-19        IPMCTL-START-DIAGNOSTIC(1)
Impressum