Commit d5a5e4ec authored by Todd Brandt's avatar Todd Brandt Committed by Rafael J. Wysocki

Add README and update pm-graph and sleepgraph docs

Config/man page/README files:
 - include README in the pm-graph folder
 - add more detail to the example config to describe more options
 - update the sleepgraph man page to document the new arguments
Signed-off-by: default avatarTodd Brandt <todd.e.brandt@linux.intel.com>
[ rjw: Subject ]
Signed-off-by: default avatarRafael J. Wysocki <rafael.j.wysocki@intel.com>
parent 45dd0a42
This diff is collapsed.
...@@ -98,12 +98,34 @@ postdelay: 0 ...@@ -98,12 +98,34 @@ postdelay: 0
# graph only devices longer than min in the timeline (default: 0.001 ms) # graph only devices longer than min in the timeline (default: 0.001 ms)
mindev: 0.001 mindev: 0.001
# Call Loop Max Gap (dev mode only)
# merge loops of the same call if each is less than maxgap apart (def: 100us)
callloop-maxgap: 0.0001
# Call Loop Max Length (dev mode only)
# merge loops of the same call if each is less than maxlen in length (def: 5ms)
callloop-maxlen: 0.005
# Override default timeline entries:
# Do not use the internal default functions for timeline entries (def: false)
# Set this to true if you intend to only use the ones defined in the config
override-timeline-functions: true
# Override default dev timeline entries:
# Do not use the internal default functions for dev timeline entries (def: false)
# Set this to true if you intend to only use the ones defined in the config
override-dev-timeline-functions: true
# ---- Debug Options ---- # ---- Debug Options ----
# Callgraph # Callgraph
# gather detailed ftrace callgraph data on all timeline events (default: false) # gather detailed ftrace callgraph data on all timeline events (default: false)
callgraph: false callgraph: false
# Max graph depth
# limit the callgraph trace to this depth (default: 0 = all)
maxdepth: 2
# Callgraph phase filter # Callgraph phase filter
# Only enable callgraphs for one phase, i.e. resume_noirq (default: all) # Only enable callgraphs for one phase, i.e. resume_noirq (default: all)
cgphase: suspend cgphase: suspend
...@@ -131,3 +153,7 @@ timeprec: 6 ...@@ -131,3 +153,7 @@ timeprec: 6
# Add kprobe functions to the timeline # Add kprobe functions to the timeline
# Add functions to the timeline from a text file (default: no-action) # Add functions to the timeline from a text file (default: no-action)
# fadd: file.txt # fadd: file.txt
# Ftrace buffer size
# Set trace buffer size to N kilo-bytes (default: all of free memory up to 3GB)
# bufsize: 1000
...@@ -53,6 +53,11 @@ disable rtcwake and require a user keypress to resume. ...@@ -53,6 +53,11 @@ disable rtcwake and require a user keypress to resume.
Add the dmesg and ftrace logs to the html output. They will be viewable by Add the dmesg and ftrace logs to the html output. They will be viewable by
clicking buttons in the timeline. clicking buttons in the timeline.
.TP .TP
\fB-turbostat\fR
Use turbostat to execute the command in freeze mode (default: disabled). This
will provide turbostat output in the log which will tell you which actual
power modes were entered.
.TP
\fB-result \fIfile\fR \fB-result \fIfile\fR
Export a results table to a text file for parsing. Export a results table to a text file for parsing.
.TP .TP
...@@ -121,6 +126,10 @@ be created in a new subdirectory with a summary page: suspend-xN-{date}-{time}. ...@@ -121,6 +126,10 @@ be created in a new subdirectory with a summary page: suspend-xN-{date}-{time}.
Use ftrace to create device callgraphs (default: disabled). This can produce Use ftrace to create device callgraphs (default: disabled). This can produce
very large outputs, i.e. 10MB - 100MB. very large outputs, i.e. 10MB - 100MB.
.TP .TP
\fB-ftop\fR
Use ftrace on the top level call: "suspend_devices_and_enter" only (default: disabled).
This option implies -f and creates a single callgraph covering all of suspend/resume.
.TP
\fB-maxdepth \fIlevel\fR \fB-maxdepth \fIlevel\fR
limit the callgraph trace depth to \fIlevel\fR (default: 0=all). This is limit the callgraph trace depth to \fIlevel\fR (default: 0=all). This is
the best way to limit the output size when using callgraphs via -f. the best way to limit the output size when using callgraphs via -f.
...@@ -138,8 +147,8 @@ which are barely visible in the timeline. ...@@ -138,8 +147,8 @@ which are barely visible in the timeline.
The value is a float: e.g. 0.001 represents 1 us. The value is a float: e.g. 0.001 represents 1 us.
.TP .TP
\fB-cgfilter \fI"func1,func2,..."\fR \fB-cgfilter \fI"func1,func2,..."\fR
Reduce callgraph output in the timeline by limiting it to a list of calls. The Reduce callgraph output in the timeline by limiting it certain devices. The
argument can be a single function name or a comma delimited list. argument can be a single device name or a comma delimited list.
(default: none) (default: none)
.TP .TP
\fB-cgskip \fIfile\fR \fB-cgskip \fIfile\fR
...@@ -183,6 +192,9 @@ Print out the contents of the ACPI Firmware Performance Data Table. ...@@ -183,6 +192,9 @@ Print out the contents of the ACPI Firmware Performance Data Table.
\fB-battery\fR \fB-battery\fR
Print out battery status and current charge. Print out battery status and current charge.
.TP .TP
\fB-wifi\fR
Print out wifi status and connection details.
.TP
\fB-xon/-xoff/-xstandby/-xsuspend\fR \fB-xon/-xoff/-xstandby/-xsuspend\fR
Test xset by attempting to switch the display to the given mode. This Test xset by attempting to switch the display to the given mode. This
is the same command which will be issued by \fB-display \fImode\fR. is the same command which will be issued by \fB-display \fImode\fR.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment