Documentation/gpu/drm-usage-stats.rst

1 .. _drm-client-usage-stats:
8 `fops->show_fdinfo()` as part of the driver specific file operations registered
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 ---------
39 ----------
41 - <uint> - Unsigned integer without defining the maximum value.
42 - <keystr> - String excluding any above defined reserved characters or whitespace.
43 - <valstr> - String.
45 Mandatory fully standardised keys
46 ---------------------------------
48 - drm-driver: <valstr>
53 Optional fully standardised keys
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
94 - drm-engine-capacity-<keystr>: <uint>
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>
106 drm-engine-<keystr> tag and shall contain the number of busy cycles for the given
115 - drm-total-cycles-<keystr>: <uint>
118 drm-cycles-<keystr> tag and shall contain the total number cycles for the given
122 of drm-cycles-<keystr>. For drivers that implement this interface, the engine
126 A driver may implement either this key or drm-maxfreq-<keystr>, but not both.
128 - drm-maxfreq-<keystr>: <uint> [Hz|MHz|KHz]
131 drm-engine-<keystr> tag and shall contain the maximum frequency for the given
132 engine.  Taken together with drm-cycles-<keystr>, this can be used to calculate
133 percentage utilization of the engine, whereas drm-engine-<keystr> only reflects
137 A driver may implement either this key or drm-total-cycles-<keystr>, but not
143 - drm-memory-<region>: <uint> [KiB|MiB]
153 indicating kibi- or mebi-bytes.
155 - drm-shared-<region>: <uint> [KiB|MiB]
160 - drm-total-<region>: <uint> [KiB|MiB]
164 - drm-resident-<region>: <uint> [KiB|MiB]
168 - drm-purgeable-<region>: <uint> [KiB|MiB]
172 - drm-active-<region>: <uint> [KiB|MiB]
185 -------------------------------
187 * :ref:`i915-usage-stats`
188 * :ref:`panfrost-usage-stats`
189 * :ref:`xe-usage-stats`