xref: /linux/tools/power/pm-graph/config/example.cfg (revision 0526b56cbc3c489642bd6a5fe4b718dea7ef0ee8)
1#
2# Generic S3 (Suspend to Mem) test
3#
4# This is the configuration file for sleepgraph. It contains
5# all the tool arguments so that they don't have to be given on the
6# command line. It also includes advanced settings for functions
7# and kprobes. It is run like this
8#
9#    sudo ./sleepgraph.py -config config/example.cfg
10#
11
12[Settings]
13
14# ---- General Options ----
15
16# Verbosity
17# print verbose messages (default: false)
18verbose: false
19
20# Suspend Mode
21# e.g. standby, mem, freeze, disk (default: mem)
22mode: mem
23
24# Output Directory Format
25# output folder for html, ftrace, and dmesg. Use {date} and {time} for current values
26output-dir: suspend-{hostname}-{date}-{time}
27
28# Automatic Wakeup
29# Use rtcwake to autoresume after X seconds, or off to disable (default: 15)
30rtcwake: 15
31
32# Add Logs
33# add the dmesg and ftrace log to the html output (default: false)
34addlogs: true
35
36# Suspend/Resume Gap
37# insert a small visible gap between suspend and resume on the timeline (default: false)
38srgap: false
39
40# Skip HTML generation
41# Only capture the logs, don't generate the html timeline (default: false)
42skiphtml: false
43
44# Sync filesystem before suspend
45# run sync before the test, minimizes sys_sync call time (default: false)
46sync: true
47
48# Runtime suspend enable/disable
49# Enable/disable runtime suspend for all devices, restore all after test (default: no-action)
50# rs: disable
51
52# Turn display on/off for test
53# Switch the display on/off for the test using xset (default: no-action)
54# display: on
55
56# Print results to text file
57# Print the status of the test run in the given file (default: no-action)
58result: result.txt
59
60# Gzip the log files to save space
61# Gzip the generated log files, and read gzipped log files (default: false)
62gzip: true
63
64# ---- Advanced Options ----
65
66# Command to execute in lieu of suspend (default: "")
67# command: echo mem > /sys/power/state
68
69# Display user processes
70# graph user processes and cpu usage in the timeline (default: false)
71proc: false
72
73# Display function calls
74# graph source functions in the timeline (default: false)
75dev: false
76
77# Multiple test runs
78# Run N tests D seconds apart, generates separate outputs with a summary (default: false)
79# multi: 3 5
80
81# Back to Back Suspend/Resume
82# Run two suspend/resumes back to back and display in the same timeline (default: false)
83x2: false
84
85# Back to Back Suspend Delay
86# Time delay between the two test runs in ms (default: 0 ms)
87x2delay: 0
88
89# Pre Suspend Delay
90# Include an N ms delay before (1st) suspend (default: 0 ms)
91predelay: 0
92
93# Post Resume Delay
94# Include an N ms delay after (last) resume (default: 0 ms)
95postdelay: 0
96
97# Minimum Device Length
98# graph only devices longer than min in the timeline (default: 0.001 ms)
99mindev: 0.001
100
101# Call Loop Max Gap (dev mode only)
102# merge loops of the same call if each is less than maxgap apart (def: 100us)
103callloop-maxgap: 0.0001
104
105# Call Loop Max Length (dev mode only)
106# merge loops of the same call if each is less than maxlen in length (def: 5ms)
107callloop-maxlen: 0.005
108
109# Override default timeline entries:
110# Do not use the internal default functions for timeline entries (def: false)
111# Set this to true if you intend to only use the ones defined in the config
112override-timeline-functions: true
113
114# Override default dev timeline entries:
115# Do not use the internal default functions for dev timeline entries (def: false)
116# Set this to true if you intend to only use the ones defined in the config
117override-dev-timeline-functions: true
118
119# ---- Debug Options ----
120
121# Callgraph
122# gather detailed ftrace callgraph data on all timeline events (default: false)
123callgraph: false
124
125# Max graph depth
126# limit the callgraph trace to this depth (default: 0 = all)
127maxdepth: 2
128
129# Callgraph phase filter
130# Only enable callgraphs for one phase, i.e. resume_noirq (default: all)
131cgphase: suspend
132
133# Callgraph x2 test filter
134# Only enable callgraphs test 0 or 1 when using -x2 (default: 1)
135cgtest: 0
136
137# Expand Callgraph
138# pre-expand the callgraph data in the html output (default: disabled)
139expandcg: false
140
141# Minimum Callgraph Length
142# provide callgraph data for blocks longer than min (default: 0.001 ms)
143mincg: 1
144
145# Timestamp Precision
146# Number of significant digits in timestamps (0:S, [3:ms], 6:us)
147timeprec: 6
148
149# Device Filter
150# show only devices whose name/driver includes one of these strings
151# devicefilter: _cpu_up,_cpu_down,i915,usb
152
153# Add kprobe functions to the timeline
154# Add functions to the timeline from a text file (default: no-action)
155# fadd: file.txt
156
157# Ftrace buffer size
158# Set trace buffer size to N kilo-bytes (default: all of free memory up to 3GB)
159# bufsize: 1000
160