IPMCTL-DUMP-DEBUG-LOG(1)

✨ ipmctl-dump-debug-log ✨

okay bestie, welcome to the ipmctl manual page for ipmctl-dump-debug-log — yes it's a whole mouthful, yes it's iconic, and yes i'm gonna walk you through every single crumb of it. no gatekeeping here 💅

---

🎀 NAME 🎀

ipmctl-dump-debug-log — dumps encoded firmware debug logs from specified PMem modules and optionally decodes to human readable text.

like. it grabs the debug logs, and if you want, it also translates them into something your human eyeballs can actually read. we love a bilingual king 🦋

---

🌸 SYNOPSIS 🌸

ipmctl dump [OPTIONS] -destination (file_prefix) [-dict (file)] -debug [TARGETS] [PROPERTIES]

---

💖 DESCRIPTION 💖

Dumps encoded firmware debug logs from specified PMem modules and optionally decodes to human readable text using a dictionary file.

that's the whole vibe fr fr. logs out, and if you hand it a dictionary, the logs come back speaking fluent English instead of cryptic firmware gobbledygook ✨

---

⭐ OPTIONS ⭐

• -h, -help — Displays help for the command. your little safety net, bestie, use it whenever.
• -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. they are not a duo, they are an either/or situation, no cap.

• -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. same deal. one at a time, babe.

---

🦋 TARGET 🦋

• -destination (file_prefix) — The command will create files that use the given filename as a prefix and append the PMem module UID, PMem module handle, debug log source, and the appropriate file type (.bin for encoded logs, .txt for decoded logs) onto the end.

file_prefix_Uid_Handle_logsource.[bin,txt]

so like, it takes your prefix and then just keeps decorating it, adding the UID, the handle, the log source, and the file type. it's giving ✨collage art✨ but for filenames.

• -dict (path) — Optional file path to the dictionary file. If supplied, the command will create both the binary debug log and a text file with decoded log data with the file prefix specified by -destination. Firmware dictionaries are lookup tables that match firmware codes to their text descriptions. When referenced, the dictionary will be used to substitute the provided codes with text, making the logs more human readable. Dictionaries are included in every firmware release under the format nlog_dict.X.X.X.XXXX.txt.

okay so the dictionary is literally just a translation key. code goes in, words come out. dictionaries ship with every firmware release as nlog_dict.X.X.X.XXXX.txt — slay. 🌈

• -dimm [DimmIDs] — Dumps the debug logs from the specified PMem modules.

---

💜 EXAMPLES 💜

Dumps and decodes the debug log from PMem module 0x0001 and 0x0011 using the dictionary file.

ipmctl dump -destination file_prefix -dict nlog_dict.txt -debug -dimm 0x0001,0x0011

look at her go 🫶 two dimms, one dictionary, zero regrets.

---

😭 LIMITATIONS 😭

To successfully execute this command, the specified PMem modules must be manageable by the host software.

translation: if the host software can't manage them, this command is not gonna eat. it's just gonna sit there. 💀

---

👑 RETURN DATA 👑

Dumps the encoded and optionally decoded contents of all 3 firmware debug log sources for the specified PMem modules. Output file names are generated based on the -destination parameter above.

three sources. all three. no crumbs left behind. and every filename traces back to your -destination, iykyk.

---

🍓 SAMPLE OUTPUT 🍓

Dumped media FW debug logs to file (file_prefix_8089-A1-1816-00000016_0x0001_media.bin)
Decoded 456 records to file (file_prefix_8089-A1-1816-00000016_0x0001_media.txt)
No spi FW debug logs found

see how the first two are out here thriving with their little .bin and .txt files, and the third one is just… not there? relatable honestly. No spi FW debug logs found — she simply had nothing to say that day 🙈

---

🧚 SEE ALSO 🧚

nothing else listed in this one, bestie — this page is a solo act and she's owning it.

---

that's the whole page!! manual name is ipmctl, dated 2024-04-22, and this diva right here is IPMCTL-DUMP-DEBUG-LOG(1). now go dump some logs and decode them like the main character you are 💖✨🎀