Received-SPF: pass (google.com: domain of linux-kernel+bounces-19041-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:40f1:3f00::1 as permitted sender) client-ip=2604:1380:40f1:3f00::1;
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>
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 v5 RESEND 3/3] docs: perf: Add description for StarFive's StarLink PMU
Date: Mon,  8 Jan 2024 07:56:57 +0800
Message-ID: <20240107235657.2372910-4-jisheng.teoh@starfivetech.com>
In-Reply-To: <20240107235657.2372910-1-jisheng.teoh@starfivetech.com>
References: <20240107235657.2372910-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?1O69EnH3fObF/HtHUcCTpGLeMOGIdNy464qzETTj3delJrkpXPRLEADVyjEV?=
 =?us-ascii?Q?KTHchSFg4c3QdzeOzCVADroMozCHYMBInj92DAc3PhuaS7Deo482rtxqW5U9?=
 =?us-ascii?Q?w0jja8NKtFJ0+lrBbvhcRBKWqxyhto5TxdiVLdddJepOYOcTowY9d61+yc0S?=
 =?us-ascii?Q?N3ifvOfBl5ATRISu07S7qfk5w98uSm9s4zGe0cE+x/86a8zjsMKtP77McZeq?=
 =?us-ascii?Q?VZ++jWCRIGtM17uFO+HZ2Q+FqNR06H4TIMmkCpU8NwaJGcAr7QfB9obXL9EG?=
 =?us-ascii?Q?r4JgPcJghurmrwY9oS9vA7Pl+FuAC7xS+DD5dRuJBphe092F3CNXndSI/iJp?=
 =?us-ascii?Q?tyjnTWazoPdfSXe6w+f0ji13iijmUBSxK+Ve9iIKReMLQUzlOVUdBt6SOnHi?=
 =?us-ascii?Q?X7mGp5L3dObz9Ek4qAJOPKtoo1fkscZMbTWohbvYU927bbEm1XG/WMCkcJu4?=
 =?us-ascii?Q?3bz2fywTibY9rk4RZBMxo+sp1En+gPbefEUFSQKX83DKyv+M02iVq0j+KjUl?=
 =?us-ascii?Q?FBvpcMWPL5h+PhLM5Y0eAsW5S+lmvqVSLKdjOrpYygZlXy0bzISjYa4nga/4?=
 =?us-ascii?Q?+kPo5qulV2jE+JWCga3Kfyv58lFq470gtNU4PjhmO9UfvQg3fyIhMQCYBG6R?=
 =?us-ascii?Q?+dzBGN5fgXYnnZEh+ODXa3Uy5F9uAyCeZ4feJGkIWr+hdW7T7i+yHT66sH74?=
 =?us-ascii?Q?Dd3K3MbUZhHuxk25rsHZqQJb6h6LbFisDWeUc+HriCfZYApj3p6An3bgn7Rg?=
 =?us-ascii?Q?vtKBZ+roPcN7dDw2MOqBC8lyRy1mf4ns5DLhwi3fp0AUVEWYQuw1wuM0bw5p?=
 =?us-ascii?Q?jJ604+Q7bR31fZ1QtxVn60etdzi5KykuDgj+9wN7WSRer9lOiFGd+iJT8zpA?=
 =?us-ascii?Q?M/e5W+y9x2Z7DUguc884TxQX8gAKT8Hv9zH826AV5SA3Oec5eMtTMQiTvJ83?=
 =?us-ascii?Q?NflabtOUkRlIkgeoTjjA5vBIt/5HWL8KHSw5tSalQVjDd6buh96kxGsH/tXt?=
 =?us-ascii?Q?Jjfr7SMQCPR2GCVxrt8KUgPnMnxZ8gXEJ6oIXpbS8R8hxBgiajuI6es8iMDh?=
 =?us-ascii?Q?kUHXFuZjtsg/eh7rjBBxez9GnNLwvXk0+5vFLEXgmW4P6NZDOb/0B8P5GJQh?=
 =?us-ascii?Q?HSv8CyKNJ4TjqkyGbjvN498hgJY9YhpwpzYap+q9j5Oa6kv3Z2pdQhfuSOTP?=
 =?us-ascii?Q?mZsjfUDuzXnzeyK6qaHNzz4R86nrRLpeh/4KaTxVDLdBu+e78ni+nV4nDa+v?=
 =?us-ascii?Q?CSpBLI3RbROZU0HfYw2x5J9zCispgw5ksbYQfN1AofdmYG3tB7QTWHTEaEE9?=
 =?us-ascii?Q?2yQ7mCAQrqo7QMWx4a38R47xEwvhixSCQ6IqIm/S3C3/KYD1arW+yjDLTsKk?=
 =?us-ascii?Q?jLJmgCDX2sQNdOQiRoJw0IRpsFXaAZ514bnF/8UrqCJQ2v4xunbrNlCVYzaR?=
 =?us-ascii?Q?Rf+uazM9igPcZykQPKCBCKLgrR1RTirFjySgq2+zGaOjtvmLhnMjXsRBpC32?=
 =?us-ascii?Q?aKtqpqv3xqH/NbNxSenhtZ+t1jvUsBaZIx120ahSl/xiwnbrRfw6HttcYqkF?=
 =?us-ascii?Q?Rn7xHv7fvSxoFY10T5n1OY1O8K4VkFydJ6epI+gjRPETQshPFAOm+pKCYwWF?=
 =?us-ascii?Q?RQ=3D=3D?=
X-OriginatorOrg: starfivetech.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 4588136e-4952-4ece-6589-08dc0fdc757a
X-MS-Exchange-CrossTenant-AuthSource: ZQ0PR01MB1160.CHNPR01.prod.partner.outlook.cn
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 07 Jan 2024 23:57:51.9953
 (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: 2ovtr2P7ECRqwaYOzbsOzFmgxamZju67aJituGtTz9cXuKHiq4/4waum4gwaMR5PBMgmTGrOwTPMJh3XjcZAeuTP0CL4e2uP/O9dgjve5ME=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: ZQ0PR01MB1032

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.25.1