pps: Intel documentation

Add documentation for the Intel Perfetto datasource.

Signed-off-by: Antonio Caggiano <antonio.caggiano@collabora.com>
Reviewed-by: Lionel Landwerlin <lionel.g.landwerlin@intel.com>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/10216>

diff --git a/docs/perfetto.rst b/docs/perfetto.rst
index 18d8943..947a492 100644 (file)
--- a/docs/perfetto.rst
+++ b/docs/perfetto.rst
@@ -37,6 +37,9 @@ The exact supported features vary per driver:
    * - Turnip
      - ``gpu.counters.msm``
      -
+   * - Intel
+     - ``gpu.counters.i915``
+     -
 
 Run
 ---
@@ -88,7 +91,26 @@ performance counters, so you can simply run it with sudo:
 
 .. code-block:: console
 
-   sudo ./build/pps-producer
+   sudo ./build/src/tool/pps/pps-producer
+
+Intel
+^^^^^
+
+The Intel PPS driver needs root access to read system-wide
+`RenderBasic <https://software.intel.com/content/www/us/en/develop/documentation/vtune-help/top/reference/gpu-metrics-reference.html>`__
+performance counters, so you can simply run it with sudo:
+
+.. code-block:: console
+
+   sudo ./build/src/tool/pps/pps-producer
+
+Another option to enable access wide data without root permissions would be running the following:
+
+.. code-block:: console
+
+   sudo sysctl dev.i915.perf_stream_paranoid=0
+
+Alternatively using the ``CAP_PERFMON`` permission on the binary should work too.
 
 Troubleshooting
 ---------------