IPMCTL-START-DIAGNOSTIC(1)

📦
version 03.00.00.0485 · 6 versions
, in ubuntu noble, ubuntu questing

💖 IPMCTL-START-DIAGNOSTIC 💖

okay bestie, so this is a page from the ipmctl manual, section 1, and it's literally called ipmctl-start-diagnostic. it starts a diagnostic test. that's the whole vibe. let's get into it 🩺✨

✨ NAME ✨

ipmctl-start-diagnostic — Starts a diagnostic test 🧪

🌸 SYNOPSIS 🌸

ipmctl start [OPTIONS] -diagnostic [TARGETS]

🦋 DESCRIPTION 🦋

Starts a diagnostic test. that's it, that's the sentence, no notes 💅

👑 OPTIONS 👑

  • -h, -help — Displays help for the command. your lil safety net fr fr 🫶
  • -ddrt — Used to specify DDRT as the desired transport protocol for the current invocation of ipmctl.
  • -smbus — Used to specify SMBUS as the desired transport protocol for the current invocation of ipmctl.
⚠️ Note: the -ddrt and -smbus options are mutually exclusive and may not be used together. pick ONE bestie, they do not coexist 😭
  • -lpmb — Used to specify large transport payload size for the current invocation of ipmctl.
  • -spmb — Used to specify small transport payload size for the current invocation of ipmctl.
⚠️ Note: the -lpmb and -spmb options are mutually exclusive and may not be used together. again: one. not both. 🙈
  • -o (text|nvmxml), -output (text|nvmxml) — Changes the output format. One of: "text" (default) or "nvmxml". so you either get the classic text or the nvmxml glow-up ✨

🎀 TARGETS 🎀

  • -diagnostic [Quick|Config|Security|FW] — Start a specific test by supplying its name. All tests are run by default. One of:
    • "Quick" — This test verifies that the PMem module host mailbox is accessible and that basic health indicators can be read and are currently reporting acceptable values. a lil wellness check 🩺
    • "Config" — This test verifies that the BIOS platform configuration matches the installed hardware and the platform configuration conform to best known practices. it's giving "does your outfit match the occasion" but for hardware 👗
    • "Security" — This test verifies that all PMem modules have a consistent security state. It is a best practice to enable security on all PMem modules rather than just some. no half-in half-out energy, all of them or it's messy 💀
    • "FW" — This test verifies that all PMem modules of a given model have consistent FW installed and other FW modifiable attributes are set in accordance with best practices. Note that the test does not have a means of verifying that the installed FW is the optimal version for a given PMem module model just that it has been consistently applied across the system. so it checks consistency, not perfection — read the fine print bestie 📝
  • -dimm [DimmIDS] — Starts a diagnostic test on specific PMem modules by optionally supplying one or more comma separated PMem module identifiers. The default is to start the specified tests on all manageable PMem modules. Only valid for the Quick diagnostic test. so if you try this with anything but Quick, that's a no 💅

🌈 EXAMPLES 🌈

Starts all diagnostics.

ipmctl start -diagnostic

Starts the quick check diagnostic on PMem module 0x0001.

ipmctl start -diagnostic Quick -dimm 0x0001

💜 LIMITATIONS 💜

If a PMem module is unmanageable, then Quick test will report the reason, while Config, Security and FW tests will skip unmanageable PMem modules. so Quick is the one that actually tells you what's wrong, the others just quietly move on 😭

⭐ RETURN DATA ⭐

Each diagnostic generates one or more log messages. A successful test generates a single log message per PMem module indicating that no errors were found. A failed test might generate multiple log messages each highlighting a specific error with all the relevant details. Each log contains the following information.

  • Test — The test name along with overall execution result. One of:
    • "Quick"
    • "Config"
    • "Security"
    • "FW"
  • State — The collective result state for each test. One of:
    • "Ok"
    • "Warning"
    • "Failed"
    • "Aborted"
  • Message — The message indicates the status of the test. One of:
    • "Ok"
    • "Failed"
  • SubTestName — The subtest name for given Test.

🧚 Valid SubTest Names by Test Name 🧚

  • Test Name: Quick — valid SubTest Names:
    • Manageability
    • Boot status
    • Health
  • Test Name: Config — valid SubTest Names:
    • PMem module specs
    • Duplicate PMem module
    • System Capability
    • Namespace LSA
    • PCD
  • Test Name: Security — valid SubTest Names:
    • Encryption status
    • Inconsistency
  • Test Name: FW — valid SubTest Names:
    • FW Consistency
    • Viral Policy
    • Threshold check
    • System Time
  • State — The severity of the error for each sub-test displayed with SubTestName. One of:
    • "Ok"
    • "Warning"
    • "Failed"
    • "Aborted"

Events are generated as a result of invoking the Start Diagnostics command in order to analyze the Intel® Optane™ PMem module for potential issues.

Diagnostic events may fall into the following categories:

  • Quick health diagnostic test event
  • Platform configuration diagnostic test event
  • Security diagnostic test event
  • Firmware consistency and settings diagnostic test event

Each event includes the following pieces of information:

  • The severity of the event that occurred. One of:
    • Informational (Info)
    • Warning (Warning)
    • Error (Failed)
    • Aborted (Aborted)
  • A unique ID of the item (PMem module UUID, DimmID, NamespaceID, RegionID, etc.) the event refers to.
  • A detailed description of the event in English.

The following sections list each of the possible events grouped by category of the event.

💖 Quick Health Check Events 💖

The quick health check diagnostic verifies that the Intel® Optane™ PMem module's host mailboxes are accessible and that basic health indicators can be read and are currently reporting acceptable values.

✨ Table 1. Table Quick Health Check Events ✨

okay bestie, gather round 🫶 this is the full roster of events the quick health check can throw at you. every single one comes with a Code, a Severity, a Message, and a lil set of Arguments that get slotted into the message wherever you see [1], [2], [3], [4] — it's giving mad-libs but make it PMem 💅

  • 500 — Info 🌈
    • Message: The quick health check succeeded.
    • Arguments: none, zero, zilch — it's just here to say everything's cute ✨
  • 501 — Warning ⚠️
    • Message: The quick health check detected that PMem module [1] is not manageable because subsystem vendor ID [2] is not supported. UID: [3]
    • Arguments:
      1. PMem module Handle
      2. Subsystem Vendor ID
      3. PMem module UID
  • 502 — Warning ⚠️
    • Message: The quick health check detected that PMem module [1] is not manageable because subsystem device ID [2] is not supported. UID: [3]
    • Arguments:
      1. PMem module Handle
      2. Subsystem Device ID
      3. PMem module UID
  • 503 — Warning ⚠️
    • Message: The quick health check detected that PMem module [1] is not manageable because firmware API version [2] is not supported. UID: [3]
    • Arguments:
      1. PMem module Handle
      2. FW API version
      3. PMem module UID
  • 504 — Warning ⚠️
    • Message: The quick health check detected that PMem module [1] is reporting a bad health state [2]. UID: [3]
    • Arguments:
      1. PMem module Handle
      2. Actual Health State
      3. PMem module UID
  • 505 — Warning 🥵
    • Message: The quick health check detected that PMem module [1] is reporting a media temperature of [2] C which is above the alarm threshold [3] C. UID: [4]
    • Arguments:
      1. PMem module Handle
      2. Actual Media Temperature
      3. Media Temperature Threshold
      4. PMem module UID
  • 506 — Warning 📉
    • Message: The quick health check detected that PMem module [1] is reporting percentage remaining at [2]% which is less than the alarm threshold [3]%. UID: [4]
    • Arguments:
      1. PMem module Handle
      2. Actual Percentage Remaining
      3. Percentage Remaining Threshold
      4. PMem module UID
  • 507 — Warning 🔄
    • Message: The quick health check detected that PMem module [1] is reporting reboot required. UID: [2]
    • Arguments:
      1. PMem module Handle
      2. PMem module UID
  • 511 — Warning 🥵
    • Message: The quick health check detected that PMem module [1] is reporting a controller temperature of [2] C which is above the alarm threshold [3] C. UID: [4]
    • Arguments:
      1. PMem module Handle
      2. Actual Controller Temperature
      3. Controller Temperature Threshold
      4. PMem module UID
  • 513 — Error 💀
    • Message: The quick health check detected that the boot status register of PMem module [1] is not readable. UID: [2]
    • Arguments:
      1. PMem module Handle
      2. PMem module UID

and that's a whole lotta events, so don't you dare scroll away yet 🫶

514 — Error 💀

Not me finding out the media on PMem module [1] is literally not ready 😭 the firmware is out here reporting it and everything. UID: [2]

Return data:

  1. PMem module Handle
  2. PMem module UID

515 — Error 💀

Bestie, the firmware on PMem module [1] is reporting an error in the media. Not a vibe. UID: [2]

Return data:

  1. PMem module Handle
  2. PMem module UID

519 — Error 💀

PMem module [1] failed to initialize BIOS POST testing 😳 it just did not show up to the group chat. UID: [2]

Return data:

  1. PMem module Handle
  2. PMem module UID

520 — Error 💀

The firmware on PMem module [1] has not initialized successfully. The last known Major:Minor Checkpoint is [2]. UID: [3]

Return data:

  1. PMem module Handle
  2. Major checkpoint : Minor checkpoint in Boot Status Register
  3. PMem module UID

523 — Error 🔥

PMem module [1] is reporting a viral state 😱 and the way that this means the PMem module is now read-only… yeah. It's giving "we're done here." UID: [2]

Lowkey important: viral state = read-only. That part is not a drill, bestie.

Return data:

  1. PMem module Handle
  2. PMem module UID

529 — Warning 🫶

PMem module [1] is reporting that it has no package spares available. It's out here with an empty snack drawer fr. UID: [2]

Return data:

  1. PMem module Handle
  2. PMem module UID

530 — Info ✨

The firmware on PMem module [1] experienced an unsafe shutdown before its latest restart. Just a lil heads up, nothing dramatic (yet). UID: [2]

Return data:

  1. PMem module Handle
  2. PMem module UID

533 — Error 💀

The firmware on PMem module [1] is reporting that the AIT DRAM is not ready. UID: [2]

Return data:

  1. PMem module Handle
  2. PMem module UID

534 — Error 💀

The firmware on PMem module [1] is reporting that the media is disabled. UID: [2]

Return data:

  1. PMem module Handle
  2. PMem module UID

535 — Error 💀

The firmware on PMem module [1] is reporting that the AIT DRAM is disabled. UID: [2]

Return data:

  1. PMem module Handle
  2. PMem module UID

536 — Error 💀

The firmware on PMem module [1] failed to load successfully 😭 no cap. UID: [2]

Return data:

  1. PMem module Handle
  2. PMem module UID

538 — Error 💀

PMem module [1] is reporting that the DDRT IO Init is not complete. UID: [2]

Return data:

  1. PMem module Handle
  2. PMem module UID
  • 539 — Error 💀 — PMem module [1] is reporting that the mailbox interface is not ready. UID: [2]
    • 1. PMem module Handle
    • 2. PMem module UID
  • 540 — Error 💀 — An internal error caused the quick health check to abort on PMem module [1]. UID: [2]
    • 1. PMem module Handle
    • 2. PMem module UID
  • 541 — Error 💀 — The quick health check detected that PMem module [1] is busy. UID: [2]
    • 1. PMem module Handle
    • 2. PMem module UID
  • 542 — Error 💀 — The quick health check detected that the platform FW did not map a region to SPA on PMem module [1]. ACPI NFIT NVPMem module State Flags Error Bit 6 Set. UID: [2]
    • 1. PMem module Handle
    • 2. PMem module UID
  • 543 — Error 💀 — The quick health check detected that PMem module [1] DDRT Training is not complete/failed. UID: [2]
    • 1. PMem module Handle
    • 2. PMem module UID
  • 544 — Error 💀 — PMem module [1] is reporting that the DDRT IO Init is not started. UID: [2]
    • 1. PMem module Handle
    • 2. PMem module UID
  • 545 — Error 💀 — The quick health check detected that the ROM on PMem module [1] has failed to complete initialization, last known Major:Minor Checkpoint is [2].
    • 1. PMem module Handle
    • 2. Major checkpoint : Minor checkpoint in Boot Status Register
    • 3. PMem module UID

🧚 Platform Configuration Check Events 🧚

okay so this diagnostic test group is the one that's like… bestie, is your BIOS actually configured right?? 💅 It verifies that the BIOS platform configuration matches the installed hardware, and that the platform configuration conforms to best known practices. no cap, it's the vibe check for your firmware settings 🌸

🩺 Table 2. Table Platform Configuration Check Events 🩺

okay bestie, this is the big one — every single platform config check event, what it means, and what it hands you back. placeholders like [1] and [2] are the arguments, in order, so read them together, k? ✨

  • 600 — severity: Info 💖
    • message: "The platform configuration check succeeded."
    • arguments: none — she's just here to say hi and slay 🎀
  • 601 — severity: Info 💖
    • message: "The platform configuration check detected that there are no manageable PMem modules."
    • arguments: none
  • 606 — severity: Info 💖
    • message: "The platform configuration check detected that PMem module [1] is not configured. UID: [2]"
    • arguments:
      1. PMem module Handle
      2. PMem module UID
  • 608 — severity: Error 💀
    • message: "The platform configuration check detected [1] PMem modules installed on the platform with the same serial number [2]."
    • arguments:
      1. Number of PMem modules with duplicate serial numbers.
      2. The duplicate serial number
  • 609 — severity: Info 💖
    • message: "The platform configuration check detected that PMem module [1] has a goal configuration that has not yet been applied. A system reboot is required for the new configuration to take effect. UID: [2]"
    • arguments:
      1. PMem module Handle
      2. PMem module UID
  • 618 — severity: Error 💀
    • message: "The platform configuration check detected that a PMem module with physical ID [1] is present in the system but failed to initialize. UID: [2]"
    • arguments:
      1. PMem module handle in the SMBIOS table
      2. PMem module UID
  • 621 — severity: Error 💀
    • message: "The platform configuration check detected PCD contains invalid data on PMem module [1]. UID: [2]"
    • arguments:
      1. PMem module Handle
      2. PMem module UID
  • 622 — severity: Error 💀
    • message: "The platform configuration check was unable to retrieve the namespace information."
    • arguments: none
  • 623 — severity: Warning ⚠️
    • message: "The platform configuration check detected that the BIOS settings do not currently allow memory provisioning from this software."
    • arguments: none
  • 624 — severity: Error 💀
    • message: "The platform configuration check detected that the BIOS
    • arguments: (cut off right here in this bit — the rest of this one is coming up next, hold on bestie 🫶)
ngl this table is giving long, but every code matters, so we're doing all of them. no skipping, no summarising, periodt. 💅

💀 the row with an empty code box

bestie this row has nothing in the code column, and that's not a glitch — it means it's a continuation of the code from right before it. Same code, extra drama. 😭

  • Severity: Error
  • What it's saying: The platform configuration check detected that the BIOS could not apply the configuration goal on PMem module [1] because of errors in the goal data. The detailed status is COUT table status: [2] [3], Partition change table status: [4], Interleave change table 1 status: [5], Interleave change table 2 status: [6].
  • Return data:
    1. Validation Status
    2. Text error code corresponding to the status code
    3. Partition Size Change Status
    4. Interleave Change Status
    5. Interleave Change Status

🔥 625 — Error

the BIOS tried to do the thing and just... could not. the resources said no. 🙈

  • What it's saying: The platform configuration check detected that the BIOS could not apply the configuration goal on PMem module [1] because the system has insufficient resources. The detailed status is COUT table status: [2] [3], Partition change table status: [4], Interleave change table 1 status: [5], Interleave change table 2 status: [6].
  • Return data:
    1. PMem module Handle
    2. Validation Status
    3. Text error code corresponding to the status code
    4. Partition Size Change Status
    5. Interleave Change Status
    6. Interleave Change Status

😭 626 — Error

firmware said "not today" and honestly? respect. 🫶

  • What it's saying: The platform configuration check detected that the BIOS could not apply the configuration goal on PMem module [1] because of a firmware error. The detailed status is COUT table status: [2] [3], Partition change table status: [4], Interleave change table 1 status: [5], Interleave change table 2 status: [6].
  • Return data:
    1. PMem module Handle
    2. Validation Status
    3. Text error code corresponding to the status code
    4. Partition Size Change Status
    5. Interleave Change Status
    6. Interleave Change Status

💅 627 — Error

the mystery-flavoured failure. no reason given, just vibes. 👑

  • What it's saying: The platform configuration check detected that the BIOS could not apply the configuration goal on PMem module [1] for an unknown reason. The detailed status is COUT table status: [2] [3], Partition change table status: [4], Interleave change table 1 status: [5], Interleave change table 2 status: [6].
  • Return data:
    1. PMem module Handle
    2. Validation Status
    3. Text error code corresponding to the status code
    4. Partition Size Change Status
    5. Interleave Change Status
    6. Interleave Change Status

🦋 628 — Error

somebody moved the modules. the interleave set is broken and it's giving "who touched my stuff" energy. ✨

  • What it's saying: The platform configuration check detected that interleave set [1] is broken because the PMem modules were moved [2].
  • Return data:
    1. Interleave set index ID
    2. List of moved PMem modules.

🌸 629 — Error

the platform looked at ADR and was like "we don't do that here". 💀

  • What it's saying: The platform configuration check detected that the platform does not support ADR

…and therefore data integrity is not guaranteed on the PMem modules. (okay that was the tail end of the last code, we're back 💖)

  • 630 — Error — An internal error caused the platform configuration check to abort. no args, it just gave up 😭
  • 631 — Error — The platform configuration check detected that interleave set [1] is broken because the PMem module with UID: [2] is missing from location (Socket-Die-iMC-Channel-Slot) [3]. one of the girlies is literally not in the building 💀
    • Arguments — 1. Interleave set index ID 2. PMem module UID 3. Location ID
  • 632 — Error — The platform configuration check detected that interleave set [1] is broken because the PMem module with UID: [2] is misplaced. It is currently in location (Socket-Die-iMC-Channel-Slot) [3] and should be moved to (Socket-Die-iMC-Channel-Slot) [4]. she's here, she's just in the wrong seat bestie, move her 🫶
    • Arguments — 1. Interleave set index ID 2. PMem module UID 3. Location ID 4. Location ID
  • 633 — Error — The platform configuration check detected that the BIOS could not fully map memory on PMem module [1] because of an error in current configuration. The detailed status is CCUR table status: [2] [3]. the BIOS tried its best and its best was not enough 🙈
    • Arguments — 1. PMem module Handle 2. Current Configuration Status 3. Text error code corresponding to the status code

🔒 Security Check Events 🔒

The security check diagnostic test group verifies that all Intel® Optane™ PMem modules have a consistent security state. vibe check but for security settings, and everyone has to match 👑

Table 3. Table Security Check Events

  • 800 — Info — The security check succeeded. ate, no crumbs, we love to see it ✨
  • 801 — Info — The security check detected that there are no manageable PMem modules. nothing to check, the party is empty 🎀
  • 802 — Warning — The security check detected that security settings are inconsistent [1]. somebody's settings did NOT match and it's giving chaos 🌈
    • Arguments — 1. A comma separated list of the number of PMem modules in each security state
  • 804 — Info — The security check detected that security is not supported on all PMem modules. not every module even got the memo that security was a thing 🦋
  • 805 — Error — An internal error caused the security check to abort. the check literally walked out mid-conversation 💀

🛠️ Firmware Consistency and Settings Check Events 🛠️

This test group verifies that all PMem modules of a given subsystem device ID have consistent FW installed and other FW modifiable attributes are set in accordance with best practices. like a group project where everyone actually submitted the same version, and also followed the rubric 🔥

📋 Table 4. Table Firmware Consistency and Settings Check Events ✨

columns: Code, Severity, Message, Arguments — in that order, no cap 💅

okay bestie, here's the full event roster. every code, every severity, every message, every argument. no skips, no summaries, we're eating today 🍓

  • 900 — Info — the firmware consistency and settings check succeeded. no arguments, she's simply thriving 🌸
  • 901 — Info — the firmware consistency and settings check detected that there are no manageable PMem modules. no arguments, periodt 💀
  • 902 — Warning — the firmware consistency and settings check detected that firmware version on PMem modules [1] with subsystem device ID [2] is non-optimal, and the preferred version is [3].
    • Arguments:
      1. comma separated list of PMem module UIDs
      2. subsystem device ID
      3. preferred firmware version
  • 903 — Warning — the firmware consistency and settings check detected that PMem module [1] is reporting a non-critical media temperature threshold of [2] C which is above the fatal threshold [3] C. UID: [4]
    • Arguments:
      1. PMem module Handle
      2. Current media temperature threshold
      3. Fatal media temperature threshold
      4. PMem module UID
  • 904 — Warning — the firmware consistency and settings check detected that PMem module [1] is reporting a non-critical controller temperature threshold of [2] C which is above the fatal threshold [3] C. UID: [4]
    • Arguments:
      1. PMem module Handle
      2. Current controller temperature threshold
      3. Fatal controller temperature threshold
      4. PMem module UID
  • 905 — Warning — the firmware consistency and settings check detected that PMem module [1] is reporting a percentage remaining of [2]% which is below the recommended threshold [3]%. UID: [4]
    • Arguments:
      1. PMem module Handle
      2. Current percentage remaining threshold
      3. Recommended percentage remaining threshold
      4. PMem module UID
  • 906 — Warning — the firmware consistency and settings check detected that PMem modules have inconsistent viral policy settings. no arguments, just vibes and chaos 🫠
  • 910 — Error — an internal error caused the firmware consistency and settings check to abort. no arguments. this one is not cute, bestie 😭
  • 911 — Warning — the firmware consistency and settings check detected that PMem modules have inconsistent first fast refresh settings. no arguments.

and that's the whole page, bestie 💖 brought to you by ipmctl, dated 2024-04-22, living under IPMCTL-START-DIAGNOSTIC(1). mwah 💅✨

📦 where this page comes from