Mesa (main): pps: Restore documentation

[GitLab Mirror]

Module: Mesa
Branch: main
Commit: a694541709e1f6403b11e0db2a2a26521ca9f90e
URL:    http://cgit.freedesktop.org/mesa/mesa/commit/?id=a694541709e1f6403b11e0db2a2a26521ca9f90e

Author: Antonio Caggiano <antonio.caggiano at collabora.com>
Date:   Tue Jul 13 14:13:26 2021 +0200

pps: Restore documentation

Restore part of the perfetto documentation deleted by mistake.

Signed-off-by: Antonio Caggiano <antonio.caggiano at collabora.com>
Reviewed-by: Tomeu Vizoso <tomeu.vizoso at collabora.com>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/11846>

---

 docs/perfetto.rst | 40 +++++++++++++++++++++++++++++++++++++++-
 1 file changed, 39 insertions(+), 1 deletion(-)

diff --git a/docs/perfetto.rst b/docs/perfetto.rst
index 588f739f4dc..7fc20a68954 100644
--- a/docs/perfetto.rst
+++ b/docs/perfetto.rst
@@ -31,8 +31,17 @@ The exact supported features vary per driver:
    * - Driver
      - PPS Counters
      - Render Stages
+   * - Freedreno
+     - ``gpu.counters.msm``
+     - ``gpu.renderstages.msm``
+   * - Turnip
+     - ``gpu.counters.msm``
+     -
+   * - Intel
+     - ``gpu.counters.i915``
+     -
    * - Panfrost
-     - gpu.counters.panfrost
+     - ``gpu.counters.panfrost``
      -
 
 Run
@@ -76,6 +85,35 @@ Driver Specifics
 
 Below is driver specific information/instructions for the PPS producer.
 
+Freedreno / Turnip
+^^^^^^^^^^^^^^^^^^
+
+The Freedreno PPS driver needs root access to read system-wide
+performance counters, so you can simply run it with sudo:
+
+.. code-block:: console
+
+   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.
+
 Panfrost
 ^^^^^^^^