From 41039d8ee977879bf457daba76336860af288e62 Mon Sep 17 00:00:00 2001
From: Antonio Caggiano <antonio.caggiano@collabora.com>
Date: Thu, 6 May 2021 13:27:42 +0200
Subject: [PATCH] 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>
---
 docs/perfetto.rst | 24 +++++++++++++++++++++++-
 1 file changed, 23 insertions(+), 1 deletion(-)

diff --git a/docs/perfetto.rst b/docs/perfetto.rst
index 18d89435ac5..947a492f869 100644
--- 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
 ---------------