Received-SPF: pass (google.com: domain of linux-kernel+bounces-86260-linux.lists.archive=gmail.com@vger.kernel.org designates 147.75.48.161 as permitted sender) client-ip=147.75.48.161;
From: Ji Sheng Teoh <jisheng.teoh@starfivetech.com>
To: Jonathan Corbet <corbet@lwn.net>,
	Will Deacon <will@kernel.org>,
	Mark Rutland <mark.rutland@arm.com>,
	Rob Herring <robh+dt@kernel.org>,
	Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>,
	Conor Dooley <conor+dt@kernel.org>,
	Dan Williams <dan.j.williams@intel.com>,
	Ilkka Koskinen <ilkka@os.amperecomputing.com>,
	Jonathan Cameron <Jonathan.Cameron@huawei.com>,
	Dave Jiang <dave.jiang@intel.com>,
	Kan Liang <kan.liang@linux.intel.com>
Cc: Ji Sheng Teoh <jisheng.teoh@starfivetech.com>,
	Ley Foon Tan <leyfoon.tan@starfivetech.com>,
	linux-doc@vger.kernel.org,
	linux-kernel@vger.kernel.org,
	linux-arm-kernel@lists.infradead.org,
	devicetree@vger.kernel.org
Subject: [PATCH v7 3/4] docs: perf: Add description for StarFive's StarLink PMU
Date: Thu, 29 Feb 2024 15:27:19 +0800
Message-ID: <20240229072720.3987876-4-jisheng.teoh@starfivetech.com>
In-Reply-To: <20240229072720.3987876-1-jisheng.teoh@starfivetech.com>
References: <20240229072720.3987876-1-jisheng.teoh@starfivetech.com>
Content-Transfer-Encoding: 8bit
Content-Type: text/plain
Precedence: bulk
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0:
	=?us-ascii?Q?+xDynYGYR/OfggKTHSufGmbuNx8bFRlfaeey/zVXJGBRlY7Xaqtx9XMUw0Uq?=
 =?us-ascii?Q?jyIrjetqkCfKo/LcLZROuTKiaMuHZdLIL0GefwHNg4Q/PpUdwwrNYCxZkFa0?=
 =?us-ascii?Q?9KzwTZ1rxcwfzsrJAvp7efN4PxJ2pwdbxDcc49I0NtWaeG//F3piIaBnsLNx?=
 =?us-ascii?Q?DEmoZCou1E/0eXxvMlJB3CtPj6cILlqzgZVcoCmVEz6I5+TcLFIZBUaH1+XR?=
 =?us-ascii?Q?BYBm/Mo5UyxE9xQ8evjeglaMsQYmwgiOcW2hRUK/xMtKGF/kX+XkWaMTXagG?=
 =?us-ascii?Q?zltBP4Zh6NdbfmjrjHXvtHjCh0GNNH4olhNA9RIuEKxa3XNWpe9T7YydrPjL?=
 =?us-ascii?Q?SArDujSA3ow+p84aJ2dVzL37PJgZhe8M9YtMIx5/M3onp8gYZMHW3Na3Whab?=
 =?us-ascii?Q?01PYjfrb2d41voY2TDuoPzSrsdFDjuYzvtXQIe3SOmWjAa0IpLJ2YNoEnrWR?=
 =?us-ascii?Q?Pj2TNW5ckvFSl7tCNs7AKcLWIWkKVABDPwTXFHUvXBZo7+MiLiz3wtFjQXhf?=
 =?us-ascii?Q?gkNrDdlDQHuZIDvxvR07WqtJcvNgXkiO05gxfib5y9PBGNKWX5JFX2lI5DxL?=
 =?us-ascii?Q?e7aMlih24o/VAT9Sg3PqEDf8ZuCrTbGvTlPmmvLeiHTKFQUc0y62Vjlziejt?=
 =?us-ascii?Q?I0eY8xExR1zP5au2qsK4gE7b+etB5PA1zLoVizcHkMGgdz3iP7dK6uLi5HcR?=
 =?us-ascii?Q?1SEw7DZyYONJ7PZUUdDuiZ4WZcOBaQ/+28Zeo9Ymd6qmuoDhdTSH0aeaPGPT?=
 =?us-ascii?Q?21A++5CQ2+e6uytlc0kXRCdg1y8bOBSltPvB+P7/7OpSjp1U/Ez+yGSIGKBX?=
 =?us-ascii?Q?rFDTUvALZ6yp/kfcgc4hovq8/dbLAlqkdQ310Hr1V/ECD3gAouJzAA1Dd8nz?=
 =?us-ascii?Q?/n1qdCY4H9KYHujkbXTKhdldYZnC5qimLM0FkAqBQqkkf0JOOcQJ9ejEOEdm?=
 =?us-ascii?Q?aXunvtrj2lpzAppJ/4hlVnCz0R5xDKtu1RJtBp6QQGGsI13QCBwYRMpNvf4A?=
 =?us-ascii?Q?4aKkpNREOhOI4wxZxJcvgV0ZgTeifitmZizauIW2Py3DztFGf3ntLltKouj4?=
 =?us-ascii?Q?dIqjZsftFeoPvPoAJIhv0awQ1a8p06npUcr3yJdFrBk9iedVwy+Rvhc8sbVL?=
 =?us-ascii?Q?UKqPQhxDbBxgDwzUtv0NXbvZLb5s4cwqZVnucH7PZw72nchIFbV6OERjskM7?=
 =?us-ascii?Q?uS1ctppS7wHY+AOmfRFgExKXWrnwWap34xiKAQMp8f5slGHRlhwyIzhkL3Pb?=
 =?us-ascii?Q?6NHahpopvJXLn1mB7mQ6jW8vPhE4waWylUzppr3q84KX4PYZRKlnZhaIFwR+?=
 =?us-ascii?Q?T4RtK+svXmxCiMbU7U7FEkDZFOo7Qk0H7EHHfr3l978DlU3YRrp30PtCtWhW?=
 =?us-ascii?Q?1bTMV/n5dsSvpVMWDcDsSOYQ94kuh6VxXBBbGtw0afwOBULtYf4quZWXLaAg?=
 =?us-ascii?Q?KTjS9Uw482HS7ojMCLh299dytq4CgwS3W2gpMRZxiiTlFa4GEofpwRAXwif4?=
 =?us-ascii?Q?EWrGq0C1UL9cROEErwzZhbg1FTKtkvbim5aBOHIa+KPQagV2KGBEFF34y7FB?=
 =?us-ascii?Q?5ksJ53D/85I+wAHnr/6NhIXcyHWG6gJr3mLpjRdfmm4GGDdmE5vSs9PbZd1D?=
 =?us-ascii?Q?Ww=3D=3D?=
X-OriginatorOrg: starfivetech.com
X-MS-Exchange-CrossTenant-Network-Message-Id: fc89ab16-21ce-401f-983c-08dc38f84883
X-MS-Exchange-CrossTenant-AuthSource: ZQ0PR01MB1160.CHNPR01.prod.partner.outlook.cn
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 29 Feb 2024 07:30:20.1527
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 06fe3fa3-1221-43d3-861b-5a4ee687a85c
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: 6aV9pWcktfKvOp6rwP3J685BjtpAjjIIwprK2v9fUJLjxfn2blplMm6koLkqGfwmyStfXFv2NpCsMBCRV71h/W0eF5T7OthsrGxJhEI0WvY=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: ZQ0PR01MB1013

StarFive StarLink PMU support monitoring L3 memory system PMU events.
Add documentation to describe StarFive StarLink PMU support and it's
usage.

Signed-off-by: Ji Sheng Teoh <jisheng.teoh@starfivetech.com>
---
 Documentation/admin-guide/perf/index.rst      |  1 +
 .../perf/starfive_starlink_pmu.rst            | 46 +++++++++++++++++++
 2 files changed, 47 insertions(+)
 create mode 100644 Documentation/admin-guide/perf/starfive_starlink_pmu.rst

diff --git a/Documentation/admin-guide/perf/index.rst b/Documentation/admin-guide/perf/index.rst
index a2e6f2c81146..c5de7579a71b 100644
--- a/Documentation/admin-guide/perf/index.rst
+++ b/Documentation/admin-guide/perf/index.rst
@@ -13,6 +13,7 @@ Performance monitor support
    imx-ddr
    qcom_l2_pmu
    qcom_l3_pmu
+   starfive_starlink_pmu
    arm-ccn
    arm-cmn
    xgene-pmu
diff --git a/Documentation/admin-guide/perf/starfive_starlink_pmu.rst b/Documentation/admin-guide/perf/starfive_starlink_pmu.rst
new file mode 100644
index 000000000000..2932ddb4eb76
--- /dev/null
+++ b/Documentation/admin-guide/perf/starfive_starlink_pmu.rst
@@ -0,0 +1,46 @@
+================================================
+StarFive StarLink Performance Monitor Unit (PMU)
+================================================
+
+StarFive StarLink Performance Monitor Unit (PMU) exists within the
+StarLink Coherent Network on Chip (CNoC) that connects multiple CPU
+clusters with an L3 memory system.
+
+The uncore PMU supports overflow interrupt, up to 16 programmable 64bit
+event counters, and an independent 64bit cycle counter.
+The PMU can only be accessed via Memory Mapped I/O and are common to the
+cores connected to the same PMU.
+
+Driver exposes supported PMU events in sysfs "events" directory under::
+
+  /sys/bus/event_source/devices/starfive_starlink_pmu/events/
+
+Driver exposes cpu used to handle PMU events in sysfs "cpumask" directory
+under::
+
+  /sys/bus/event_source/devices/starfive_starlink_pmu/cpumask/
+
+Driver describes the format of config (event ID) in sysfs "format" directory
+under::
+
+  /sys/bus/event_source/devices/starfive_starlink_pmu/format/
+
+Example of perf usage::
+
+	$ perf list
+
+	starfive_starlink_pmu/cycles/                      [Kernel PMU event]
+	starfive_starlink_pmu/read_hit/                    [Kernel PMU event]
+	starfive_starlink_pmu/read_miss/                   [Kernel PMU event]
+	starfive_starlink_pmu/read_request/                [Kernel PMU event]
+	starfive_starlink_pmu/release_request/             [Kernel PMU event]
+	starfive_starlink_pmu/write_hit/                   [Kernel PMU event]
+	starfive_starlink_pmu/write_miss/                  [Kernel PMU event]
+	starfive_starlink_pmu/write_request/               [Kernel PMU event]
+	starfive_starlink_pmu/writeback/                   [Kernel PMU event]
+
+
+	$ perf stat -a -e /starfive_starlink_pmu/cycles/ sleep 1
+
+Sampling is not supported. As a result, "perf record" is not supported.
+Attaching to a task is not supported, only system-wide counting is supported.
-- 
2.43.0