Documentation/gpu/drm-usage-stats.rst

1 .. _drm-client-usage-stats:
8 `fops->show_fdinfo()` as part of the driver specific file operations registered
15 output is split between common and driver specific parts. Having said that,
22 - File shall contain one key value pair per one line of text.
23 - Colon character (`:`) must be used to delimit keys and values.
24 - All keys shall be prefixed with `drm-`.
25 - Whitespace between the delimiter and first non-whitespace character shall be
27 - Keys are not allowed to contain whitespace characters.
28 - Numerical key value pairs can end with optional unit string.
29 - Data type of the value is fixed as defined in the specification.
32 ---------
36 3. Driver specific.
39 ----------
41 - <uint> - Unsigned integer without defining the maximum value.
42 - <keystr> - String excluding any above defined reserved characters or whitespace.
43 - <valstr> - String.
46 ---------------------------------
48 - drm-driver: <valstr>
54 --------------------------------
59 - drm-pdev: <aaaa:bb.cc.d>
64 - drm-client-id: <uint>
71 scope of each device, in which case `drm-pdev` shall be present as well.
79 - drm-engine-<keystr>: <uint> ns
82 and unique name (keystr), with possible values documented in the driver specific
85 Value shall be in specified time units which the respective GPU engine spent
94 - drm-engine-capacity-<keystr>: <uint>
96 Engine identifier string must be the same as the one specified in the
97 drm-engine-<keystr> tag and shall contain a greater than zero number in case the
98 exported engine corresponds to a group of identical hardware engines.
103 - drm-cycles-<keystr>: <uint>
105 Engine identifier string must be the same as the one specified in the
106 drm-engine-<keystr> tag and shall contain the number of busy cycles for the given
107 engine.
115 - drm-maxfreq-<keystr>: <uint> [Hz|MHz|KHz]
117 Engine identifier string must be the same as the one specified in the
118 drm-engine-<keystr> tag and shall contain the maximum frequency for the given
119 engine.  Taken together with drm-cycles-<keystr>, this can be used to calculate
120 percentage utilization of the engine, whereas drm-engine-<keystr> only reflects
121 time active without considering what frequency the engine is operating as a
127 - drm-memory-<region>: <uint> [KiB|MiB]
137 indicating kibi- or mebi-bytes.
139 - drm-shared-<region>: <uint> [KiB|MiB]
144 - drm-total-<region>: <uint> [KiB|MiB]
148 - drm-resident-<region>: <uint> [KiB|MiB]
152 - drm-purgeable-<region>: <uint> [KiB|MiB]
156 - drm-active-<region>: <uint> [KiB|MiB]
165 are not provided by drm_show_fdinfo().  But even driver specific stats should
168 Driver specific implementations
169 -------------------------------
171 :ref:`i915-usage-stats`
172 :ref:`panfrost-usage-stats`