From nobody Wed Oct 1 23:30:10 2025 Received: from mail-pl1-f171.google.com (mail-pl1-f171.google.com [209.85.214.171]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id D55B4246787 for ; Thu, 25 Sep 2025 19:54:53 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.214.171 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1758830095; cv=none; b=aLgXw3x8QuQgLZd4f402cA84dyK/sLENKZM9tAu6n/ufVJXElQjOdMlb4JpTas2GWIizCSnwrGqgePLt7Dam+QW9pmxT7FOC8QxmC/djwOg4W5dGyO7zZvaEKHbd1wyh0nBF5ggSkCJ+CtZ5xQlteGN3QO7zcj6OowOQC1JyMKc= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1758830095; c=relaxed/simple; bh=pm5XYw0aXaktnBJIF5cJcO159P8QCT4QOXDxOjBU1n4=; h=From:To:Cc:Subject:Date:Message-ID:MIME-Version; b=PzkvB+xkz4vxC8OO0ILEdfocPj3Zcrn9Qc1/Ys5291gEEJbuDhPaDikSQalP03QSKtb74II5B/Eusg7mqJbr9JWBeha2+d0aTncsGWfkAXyA8XrvplXtGsSDHRdpv3QmMjm4a8VSVExXGaN8mCo6z0ltI1+JEZrZlj4Wwp3L1Fw= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=hMt3aSnp; arc=none smtp.client-ip=209.85.214.171 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="hMt3aSnp" Received: by mail-pl1-f171.google.com with SMTP id d9443c01a7336-26d0fbe238bso11000555ad.3 for ; Thu, 25 Sep 2025 12:54:53 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1758830093; x=1759434893; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:from:to:cc:subject:date:message-id:reply-to; bh=cUCRyPPxJwDgqGohVPvUhNuL/vkJ5zITczPe/mg3LcA=; b=hMt3aSnp85fXbHo+9nTAl8oloDRlewGAVikqGaAPvLCZW/xM2L1Ls2N+WmWrA4wWPl 9OcUkLxsEUYJnrJDr3LqesMuk+AH8vhD2RQ7Fie87Q6B7RPNgEOrHobECI4AR2jOsWMI /uMY56k3BDu5eca/4fnHncetFNBz2ixr69RkQ6Bz7X+oT+02kyZXVwNeg4DJ3P9TVjeh bFea564oNSJFuZhBcWcHV+zsKO7ARpV2aqK2hec/Cpw9FkxgDxfgGKP0wa+eJ6x66rsC LszZ5OH3FklZDM50RYlaEG9h0JeX2RFgXVD3nP5Gggd7T2MHD5boT4716Sjbz0jQKr+y imlQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1758830093; x=1759434893; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=cUCRyPPxJwDgqGohVPvUhNuL/vkJ5zITczPe/mg3LcA=; b=PxmXwjE0h1w9aHCF+DWIpNcs1jK59K4S9q9/DelRlJQHavAod0tzVTi09PDv0TM/iF lulLr0tHLp99HAqO6ft8QnzIbz8p+SfqDth5LrYYmhN0yp8ARINToBECjRYYlOTO+jAu w05P4T+5EWv97U/pjdCkxpuRp+vqvKHpl/gPJ9UZOhJR9W9gEXAVy5njpd9wvZM/YIF9 H1apeyYeBoluVezPaFziMM61V8gRPcMY5s6K3cGtAQe6Ob+wO27BJqcC+svIPkHIEEge g2EqnAWEymhK1QK+WhudNczDzKYWEguSdRxSpXx4ppjsbFsFW500HU5BC8Kw54zK1ryb R/Yw== X-Forwarded-Encrypted: i=1; AJvYcCWLlE1BeHoLfpW2koFQ1HhCvugH34noqMEC5i75b/jQulNSzl0S/JcpWqQWd9OJnxcj3UDpzC7orPDUF4U=@vger.kernel.org X-Gm-Message-State: AOJu0Ywt7fLP2QaHXXUM8HbNb1BKDx3if1GjgbvRCRMQplnJB9G3b9Z6 nNmSMyAX/eZU5kXuT3NfIXmhoK7zYzF57N6tnJvRMhFX21UPgkfW3Z6+ X-Gm-Gg: ASbGncsy9h6VAP35El6hZ/LTsopYyljaBCE8T1Dh5p27dy3XXvZrZtANiAXMbSX6J74 HgsH11VrwBnZAeMReiTKkkZSYSTV4Pq/EUxH9WkcFiTzUM0ZHvKEAvHVoIL261PYvuN/Y9qdHqT ao8307ysflZSqZgpvWDsib2ZrGzHwO0gT9QtwDzpmbDbE+JQ9Uoss83JuczH4SCBf+zeRRIXgMH MNREk//G8k7UVOzzj6iPuVIBVav3pVmk+nJdowoHAx6QGmAdnK2MijJqkdbqV5lrbLZtwNTwpsE iVCY1PtDDLQB+2Tg+S3cF37HDE7atdBzpLduD2ju8p3dTXpqm23HCtlDLGeEopoqFf2rLXao8EU Zv6UlAGvgJk/iPE0ZihU0GJWunDZ0AfbkP8iVKtChbQ== X-Google-Smtp-Source: AGHT+IHY9FrxRWml+wxJ38dtv6SdmwreMU9YpDdbSEbRQSOjOlzJqzA14wRIb8zcdNBWdW0cQAgMcA== X-Received: by 2002:a17:902:ced2:b0:24a:8e36:420a with SMTP id d9443c01a7336-27ed4aae440mr55087525ad.40.1758830093015; Thu, 25 Sep 2025 12:54:53 -0700 (PDT) Received: from kforge.gk.pfsense.com ([103.70.166.143]) by smtp.gmail.com with ESMTPSA id d9443c01a7336-27ed6ae5313sm33098765ad.149.2025.09.25.12.54.49 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 25 Sep 2025 12:54:52 -0700 (PDT) From: Gopi Krishna Menon To: corbet@lwn.net, fj2767dz@fujitsu.com, will@kernel.org, yangyicong@hisilicon.com Cc: Gopi Krishna Menon , 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 Message-ID: <20250925195442.71997-1-krishnagopi487@gmail.com> X-Mailer: git-send-email 2.43.0 Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" - 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 qu= ote 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 qu= ote 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 qu= ote ends without a blank line; unexpected unindent. Signed-off-by: Gopi Krishna Menon --- .../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/Docume= ntation/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) =20 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 na= me -mac_iod_mac_ch. +``mac_iod_mac_ch``. + And each PCI PMU on these chips is exposed as a uncore perf PMU with devic= e name -pci_iod_pci. +``pci_iod_pci``. =20 The driver provides a description of its available events and configuration -options in sysfs, see /sys/bus/event_sources/devices/mac_iod_mac= _ch/ -and /sys/bus/event_sources/devices/pci_iod_pci/. +options in sysfs, see ``/sys/bus/event_sources/devices/mac_iod_mac_ch/`` +and ``/sys/bus/event_sources/devices/pci_iod_pci/``. + This driver exports: -- formats, used by perf user space and other tools to configure events +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +- 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=3D0x21/ ls - perf stat -a -e pci_iod0_pci0/event=3D0x24/ ls + symbolically, e.g: + + .. code-block:: bash + + perf stat -a -e mac_iod0_mac0_ch0/event=3D0x21/ ls + perf stat -a -e pci_iod0_pci0/event=3D0x24/ ls + - cpumask, used by perf user space and other tools to know on which CPUs to open the events =20 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 PF= TGT 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 control= ler per cycle. -- write-count + +write-count: This event counts the number of write requests to MAC (including zero wr= ite, 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 memor= y. -- 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. =20 'ea' is the abbreviation for 'Energy Analyzer'. =20 -Examples for use with perf:: +Examples for use with perf + + .. code-block:: bash =20 - perf stat -e mac_iod0_mac0_ch0/ea-mac/ ls + perf stat -e mac_iod0_mac0_ch0/ea-mac/ ls =20 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. =20 - 'ea' is the abbreviation for 'Energy Analyzer'. + 'ea' is the abbreviation for 'Energy Analyzer'. + +Examples for use with perf: =20 -Examples for use with perf:: + .. code-block:: bash =20 - perf stat -e pci_iod0_pci0/ea-pci/ ls + perf stat -e pci_iod0_pci0/ea-pci/ ls =20 Given that these are uncore PMUs the driver does not support sampling, the= refore "perf record" will not work. Per-task perf sessions are not supported. --=20 2.43.0