From: Gopi Krishna Menon <krishnagopi487@gmail.com>
To: corbet@lwn.net, fj2767dz@fujitsu.com, will@kernel.org,
yangyicong@hisilicon.com
Cc: Gopi Krishna Menon <krishnagopi487@gmail.com>,
linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
skhan@linuxfoundation.org, david.hunter.linux@gmail.com,
linux-kernel-mentees@lists.linux.dev
Subject: [PATCH] docs: perf: cleanup fujitsu_uncore_pmu.rst and fix htmldocs warnings/errors
Date: Fri, 26 Sep 2025 01:24:40 +0530 [thread overview]
Message-ID: <20250925195442.71997-1-krishnagopi487@gmail.com> (raw)
- Adjust spacing around list and sections for better readability.
- Use definition lists for defining events.
- Replace block quotes with code blocks where appropriate.
Fixes the following htmldocs errors/warnings:
Documentation/admin-guide/perf/fujitsu_uncore_pmu.rst:20: ERROR: Unexpected indentation.
Documentation/admin-guide/perf/fujitsu_uncore_pmu.rst:23: WARNING: Block quote ends without a blank line; unexpected unindent.
Documentation/admin-guide/perf/fujitsu_uncore_pmu.rst:28: ERROR: Unexpected indentation.
Documentation/admin-guide/perf/fujitsu_uncore_pmu.rst:29: WARNING: Block quote ends without a blank line; unexpected unindent.
Documentation/admin-guide/perf/fujitsu_uncore_pmu.rst:81: ERROR: Unexpected indentation.
Documentation/admin-guide/perf/fujitsu_uncore_pmu.rst:82: WARNING: Block quote ends without a blank line; unexpected unindent.
Signed-off-by: Gopi Krishna Menon <krishnagopi487@gmail.com>
---
.../admin-guide/perf/fujitsu_uncore_pmu.rst | 130 ++++++++++++------
1 file changed, 87 insertions(+), 43 deletions(-)
diff --git a/Documentation/admin-guide/perf/fujitsu_uncore_pmu.rst b/Documentation/admin-guide/perf/fujitsu_uncore_pmu.rst
index 46595b788d3a..577bad243876 100644
--- a/Documentation/admin-guide/perf/fujitsu_uncore_pmu.rst
+++ b/Documentation/admin-guide/perf/fujitsu_uncore_pmu.rst
@@ -6,105 +6,149 @@ Fujitsu Uncore Performance Monitoring Unit (PMU)
This driver supports the Uncore MAC PMUs and the Uncore PCI PMUs found
in Fujitsu chips.
+
Each MAC PMU on these chips is exposed as a uncore perf PMU with device name
-mac_iod<iod>_mac<mac>_ch<ch>.
+``mac_iod<iod>_mac<mac>_ch<ch>``.
+
And each PCI PMU on these chips is exposed as a uncore perf PMU with device name
-pci_iod<iod>_pci<pci>.
+``pci_iod<iod>_pci<pci>``.
The driver provides a description of its available events and configuration
-options in sysfs, see /sys/bus/event_sources/devices/mac_iod<iod>_mac<mac>_ch<ch>/
-and /sys/bus/event_sources/devices/pci_iod<iod>_pci<pci>/.
+options in sysfs, see ``/sys/bus/event_sources/devices/mac_iod<iod>_mac<mac>_ch<ch>/``
+and ``/sys/bus/event_sources/devices/pci_iod<iod>_pci<pci>/``.
+
This driver exports:
-- formats, used by perf user space and other tools to configure events
+====================
+
+- formats, used by perf user space and other tools to configure events.
- events, used by perf user space and other tools to create events
- symbolically, e.g.:
- perf stat -a -e mac_iod0_mac0_ch0/event=0x21/ ls
- perf stat -a -e pci_iod0_pci0/event=0x24/ ls
+ symbolically, e.g:
+
+ .. code-block:: bash
+
+ perf stat -a -e mac_iod0_mac0_ch0/event=0x21/ ls
+ perf stat -a -e pci_iod0_pci0/event=0x24/ ls
+
- cpumask, used by perf user space and other tools to know on which CPUs
to open the events
This driver supports the following events for MAC:
-- cycles
+--------------------------------------------------
+
+cycles:
This event counts MAC cycles at MAC frequency.
-- read-count
+
+read-count:
This event counts the number of read requests to MAC.
-- read-count-request
+
+read-count-request:
This event counts the number of read requests including retry to MAC.
-- read-count-return
+
+read-count-return:
This event counts the number of responses to read requests to MAC.
-- read-count-request-pftgt
+
+read-count-request-pftgt:
This event counts the number of read requests including retry with PFTGT
flag.
-- read-count-request-normal
+
+read-count-request-normal:
This event counts the number of read requests including retry without PFTGT
flag.
-- read-count-return-pftgt-hit
+
+read-count-return-pftgt-hit:
This event counts the number of responses to read requests which hit the
PFTGT buffer.
-- read-count-return-pftgt-miss
+
+read-count-return-pftgt-miss:
This event counts the number of responses to read requests which miss the
PFTGT buffer.
-- read-wait
+
+read-wait:
This event counts outstanding read requests issued by DDR memory controller
per cycle.
-- write-count
+
+write-count:
This event counts the number of write requests to MAC (including zero write,
full write, partial write, write cancel).
-- write-count-write
+
+write-count-write:
This event counts the number of full write requests to MAC (not including
zero write).
-- write-count-pwrite
+
+write-count-pwrite:
This event counts the number of partial write requests to MAC.
-- memory-read-count
+
+memory-read-count:
This event counts the number of read requests from MAC to memory.
-- memory-write-count
+
+memory-write-count:
This event counts the number of full write requests from MAC to memory.
-- memory-pwrite-count
+
+memory-pwrite-count:
This event counts the number of partial write requests from MAC to memory.
-- ea-mac
+
+ea-mac:
This event counts energy consumption of MAC.
-- ea-memory
+
+ea-memory:
This event counts energy consumption of memory.
-- ea-memory-mac-write
+
+ea-memory-mac-write:
This event counts the number of write requests from MAC to memory.
-- ea-ha
+
+ea-ha:
This event counts energy consumption of HA.
'ea' is the abbreviation for 'Energy Analyzer'.
-Examples for use with perf::
+Examples for use with perf
+
+ .. code-block:: bash
- perf stat -e mac_iod0_mac0_ch0/ea-mac/ ls
+ perf stat -e mac_iod0_mac0_ch0/ea-mac/ ls
And, this driver supports the following events for PCI:
-- pci-port0-cycles
+
+pci-port0-cycles:
This event counts PCI cycles at PCI frequency in port0.
-- pci-port0-read-count
+
+pci-port0-read-count:
This event counts read transactions for data transfer in port0.
-- pci-port0-read-count-bus
+
+pci-port0-read-count-bus:
This event counts read transactions for bus usage in port0.
-- pci-port0-write-count
+
+pci-port0-write-count:
This event counts write transactions for data transfer in port0.
-- pci-port0-write-count-bus
+
+pci-port0-write-count-bus:
This event counts write transactions for bus usage in port0.
-- pci-port1-cycles
+
+pci-port1-cycles:
This event counts PCI cycles at PCI frequency in port1.
-- pci-port1-read-count
+
+pci-port1-read-count:
This event counts read transactions for data transfer in port1.
-- pci-port1-read-count-bus
+
+pci-port1-read-count-bus:
This event counts read transactions for bus usage in port1.
-- pci-port1-write-count
+
+pci-port1-write-count:
This event counts write transactions for data transfer in port1.
-- pci-port1-write-count-bus
+
+pci-port1-write-count-bus:
This event counts write transactions for bus usage in port1.
-- ea-pci
+
+ea-pci:
This event counts energy consumption of PCI.
- 'ea' is the abbreviation for 'Energy Analyzer'.
+ 'ea' is the abbreviation for 'Energy Analyzer'.
+
+Examples for use with perf:
-Examples for use with perf::
+ .. code-block:: bash
- perf stat -e pci_iod0_pci0/ea-pci/ ls
+ perf stat -e pci_iod0_pci0/ea-pci/ ls
Given that these are uncore PMUs the driver does not support sampling, therefore
"perf record" will not work. Per-task perf sessions are not supported.
--
2.43.0
next reply other threads:[~2025-09-25 19:54 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-09-25 19:54 Gopi Krishna Menon [this message]
2025-09-25 20:06 ` [PATCH] docs: perf: cleanup fujitsu_uncore_pmu.rst and fix htmldocs warnings/errors Shuah Khan
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=20250925195442.71997-1-krishnagopi487@gmail.com \
--to=krishnagopi487@gmail.com \
--cc=corbet@lwn.net \
--cc=david.hunter.linux@gmail.com \
--cc=fj2767dz@fujitsu.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel-mentees@lists.linux.dev \
--cc=linux-kernel@vger.kernel.org \
--cc=skhan@linuxfoundation.org \
--cc=will@kernel.org \
--cc=yangyicong@hisilicon.com \
/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