From: Jiucheng Xu <jiucheng.xu@amlogic.com>
To: <linux-kernel@vger.kernel.org>,
<linux-arm-kernel@lists.infradead.org>,
<linux-amlogic@lists.infradead.org>, <devicetree@vger.kernel.org>
Cc: Rob Herring <robh+dt@kernel.org>,
Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>,
Will Deacon <will@kernel.org>,
Mark Rutland <mark.rutland@arm.com>,
Neil Armstrong <narmstrong@baylibre.com>,
Kevin Hilman <khilman@baylibre.com>,
Jerome Brunet <jbrunet@baylibre.com>,
Martin Blumenstingl <martin.blumenstingl@googlemail.com>,
Chris Healy <cphealy@gmail.com>,
Jiucheng Xu <jiucheng.xu@amlogic.com>
Subject: [PATCH v3 2/4] docs/perf: Add documentation for the Amlogic G12 DDR PMU
Date: Mon, 1 Aug 2022 14:00:47 +0800 [thread overview]
Message-ID: <20220801060049.1655177-2-jiucheng.xu@amlogic.com> (raw)
In-Reply-To: <20220801060049.1655177-1-jiucheng.xu@amlogic.com>
Add a user guide to show how to use DDR PMU to
monitor DDR bandwidth on Amlogic G12 SoC
Signed-off-by: Jiucheng Xu <jiucheng.xu@amlogic.com>
---
Changes v2 -> v3:
- Rename doc name from aml-ddr-pmu.rst to meson-ddr-pmu.rst
Changes v1 -> v2:
- Nothing was changed
---
.../admin-guide/perf/meson-ddr-pmu.rst | 68 +++++++++++++++++++
MAINTAINERS | 1 +
2 files changed, 69 insertions(+)
create mode 100644 Documentation/admin-guide/perf/meson-ddr-pmu.rst
diff --git a/Documentation/admin-guide/perf/meson-ddr-pmu.rst b/Documentation/admin-guide/perf/meson-ddr-pmu.rst
new file mode 100644
index 000000000000..f8601f3b103e
--- /dev/null
+++ b/Documentation/admin-guide/perf/meson-ddr-pmu.rst
@@ -0,0 +1,68 @@
+.. SPDX-License-Identifier: GPL-2.0
+===========================================================
+Amlogic SoC DDR Bandwidth Performance Monitoring Unit (PMU)
+===========================================================
+
+There is a bandwidth monitor inside the DRAM contorller. The monitor include
+4 channels which can count the read/write request of accessing DRAM individually.
+It can be helpful to show if the performance bottleneck is on DDR bandwidth.
+
+Currently, this driver supports the following 5 Perf events:
+
+aml_ddr_bw/total_rw_bytes/
+aml_ddr_bw/chan_1_rw_bytes/
+aml_ddr_bw/chan_2_rw_bytes/
+aml_ddr_bw/chan_3_rw_bytes/
+aml_ddr_bw/chan_4_rw_bytes/
+
+aml_ddr_bw/chan_{1,2,3,4}_rw_bytes/ events are the channel related events.
+Each channel support using keywords as filter, which can let the channel
+to monitor the individual IP module in SoC.
+
+The following keywords are the filter:
+
+arm - DDR access request from CPU
+vpu_read1 - DDR access request from OSD + VPP read
+gpu - DDR access request from 3D GPU
+pcie - DDR access request from PCIe controller
+hdcp - DDR access request from HDCP controller
+hevc_front - DDR access request from HEVC codec front end
+usb3_0 - DDR access request from USB3.0 controller
+hevc_back - DDR access request from HEVC codec back end
+h265enc - DDR access request from HEVC encoder
+vpu_read2 - DDR access request from DI read
+vpu_write1 - DDR access request from VDIN write
+vpu_write2 - DDR access request from di write
+vdec - DDR access request from legacy codec video decoder
+hcodec - DDR access request from H264 encoder
+ge2d - DDR access request from ge2d
+spicc1 - DDR access request from SPI controller 1
+usb0 - DDR access request from USB2.0 controller 0
+dma - DDR access request from system DMA controller 1
+arb0 - DDR access request from arb0
+sd_emmc_b - DDR access request from SD eMMC b controller
+usb1 - DDR access request from USB2.0 controller 1
+audio - DDR access request from Audio module
+sd_emmc_c - DDR access request from SD eMMC c controller
+spicc2 - DDR access request from SPI controller 2
+ethernet - DDR access request from Ethernet controller
+
+The following command is to show the total DDR bandwidth:
+
+ .. code-block::bash
+
+ perf stat -a -e aml_ddr_bw/total_rw_bytes/ -I 1000 sleep 10
+
+This command will print the total DDR bandwidth per second.
+
+The following commands are to show how to use filter parameters:
+
+ .. code-block::bash
+
+ perf stat -a -e aml_ddr_bw/chan_1_rw_bytes,arm=1/ -I 1000 sleep 10
+ perf stat -a -e aml_ddr_bw/chan_2_rw_bytes,gpu=1/ -I 1000 sleep 10
+ perf stat -a -e aml_ddr_bw/chan_3_rw_bytes,arm=1,gpu=1/ -I 1000 sleep 10
+
+The 1st command show how to use channel 1 to monitor the DDR bandwidth from ARM.
+The 2nd command show using channel 2 to get the DDR bandwidth of GPU.
+The 3rd command show using channel 3 to monitor the sum of ARM and GPU.
diff --git a/MAINTAINERS b/MAINTAINERS
index ac8a98dfbacc..8ee68e699e6d 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -1054,6 +1054,7 @@ AMLOGIC DDR PMU DRIVER
M: Jiucheng Xu <jiucheng.xu@amlogic.com>
S: Supported
W: http://www.amlogic.com
+F: Documentation/admin-guide/perf/meson-ddr-pmu.rst
F: drivers/perf/amlogic/
F: include/soc/amlogic/
--
2.25.1
_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
next prev parent reply other threads:[~2022-08-01 6:03 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-08-01 6:00 [PATCH v3 1/4] perf/amlogic: Add support for Amlogic meson G12 SoC DDR PMU driver Jiucheng Xu
2022-08-01 6:00 ` Jiucheng Xu [this message]
2022-08-01 6:00 ` [PATCH v3 3/4] arm64: dts: meson: Add DDR PMU node Jiucheng Xu
2022-08-02 8:05 ` Krzysztof Kozlowski
2022-08-01 6:00 ` [PATCH v3 4/4] dt-binding: perf: Add Amlogic DDR PMU Jiucheng Xu
2022-08-01 13:43 ` Rob Herring
2022-08-02 8:04 ` Krzysztof Kozlowski
2022-08-02 9:25 ` Jiucheng Xu
2022-08-02 12:13 ` Krzysztof Kozlowski
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20220801060049.1655177-2-jiucheng.xu@amlogic.com \
--to=jiucheng.xu@amlogic.com \
--cc=cphealy@gmail.com \
--cc=devicetree@vger.kernel.org \
--cc=jbrunet@baylibre.com \
--cc=khilman@baylibre.com \
--cc=krzysztof.kozlowski+dt@linaro.org \
--cc=linux-amlogic@lists.infradead.org \
--cc=linux-arm-kernel@lists.infradead.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mark.rutland@arm.com \
--cc=martin.blumenstingl@googlemail.com \
--cc=narmstrong@baylibre.com \
--cc=robh+dt@kernel.org \
--cc=will@kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).