1IPMCTL-DUMP-DEBUG-LOG(1)            ipmctl            IPMCTL-DUMP-DEBUG-LOG(1)
2
3
4

NAME

6       ipmctl-dump-debug-log - Dumps encoded firmware debug logs from
7       specified PMem modules and optionally decodes to human readable text.
8

SYNOPSIS

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

DESCRIPTION

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

OPTIONS

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

TARGET

45       -destination (file_prefix)
46           The command will create files that use the given filename as a
47           prefix and append the PMem module UID, PMem module handle, debug
48           log source, and the appropriate file type (.bin for encoded logs,
49           .txt for decoded logs) onto the end.
50
51           file_prefix_Uid_Handle_logsource.[bin,txt]
52
53       -dict (path)
54           Optional file path to the dictionary file. If supplied, the command
55           will create both the binary debug log and a text file with decoded
56           log data with the file prefix specified by -destination. Firmware
57           dictionaries are lookup tables that match firmware codes to their
58           text descriptions. When referenced, the dictionary will be used to
59           substitute the provided codes with text, making the logs more human
60           readable. Dictionaries are included in every firmware release under
61           the format nlog_dict.X.X.X.XXXX.txt.
62
63       -dimm [DimmIDs]
64           Dumps the debug logs from the specified PMem modules.
65

EXAMPLES

67       Dumps and decodes the debug log from PMem module 0x0001 and 0x0011
68       using the dictionary file.
69
70           ipmctl dump -destination file_prefix -dict nlog_dict.txt -debug -dimm 0x0001,0x0011
71

LIMITATIONS

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

RETURN DATA

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

SAMPLE OUTPUT

82           Dumped media FW debug logs to file (file_prefix_8089-A1-1816-00000016_0x0001_media.bin)
83           Decoded 456 records to file (file_prefix_8089-A1-1816-00000016_0x0001_media.txt)
84           No spi FW debug logs found
85
86
87
88ipmctl                            2022-02-01          IPMCTL-DUMP-DEBUG-LOG(1)
Impressum