Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

docs: perf: Add imx-ddr to documentation index

Sphinx is currently outputting a warning where
the file 'imx-ddr.rst' is not included in the
documentation index. Additionally, the code
highlighting and doc formatting can be slightly
improved.

Signed-off-by: Adam Zerella <adam.zerella@gmail.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>

authored by

Adam Zerella and committed by
Jonathan Corbet
0522e130 81929718

+22 -12
+21 -12
Documentation/admin-guide/perf/imx-ddr.rst
··· 18 18 devices/imx8_ddr0/format/. The "events" directory describes the events types 19 19 hardware supported that can be used with perf tool, see /sys/bus/event_source/ 20 20 devices/imx8_ddr0/events/. 21 - e.g.:: 21 + 22 + .. code-block:: bash 23 + 22 24 perf stat -a -e imx8_ddr0/cycles/ cmd 23 25 perf stat -a -e imx8_ddr0/read/,imx8_ddr0/write/ cmd 24 26 ··· 33 31 Filter is defined with two configuration parts: 34 32 --AXI_ID defines AxID matching value. 35 33 --AXI_MASKING defines which bits of AxID are meaningful for the matching. 36 - 0:corresponding bit is masked. 37 - 1: corresponding bit is not masked, i.e. used to do the matching. 34 + 35 + - 0: corresponding bit is masked. 36 + - 1: corresponding bit is not masked, i.e. used to do the matching. 38 37 39 38 AXI_ID and AXI_MASKING are mapped on DPCR1 register in performance counter. 40 39 When non-masked bits are matching corresponding AXI_ID bits then counter is 41 40 incremented. Perf counter is incremented if 42 - AxID && AXI_MASKING == AXI_ID && AXI_MASKING 41 + AxID && AXI_MASKING == AXI_ID && AXI_MASKING 43 42 44 43 This filter doesn't support filter different AXI ID for axid-read and axid-write 45 44 event at the same time as this filter is shared between counters. 46 - e.g.:: 47 - perf stat -a -e imx8_ddr0/axid-read,axi_mask=0xMMMM,axi_id=0xDDDD/ cmd 48 - perf stat -a -e imx8_ddr0/axid-write,axi_mask=0xMMMM,axi_id=0xDDDD/ cmd 49 45 50 - NOTE: axi_mask is inverted in userspace(i.e. set bits are bits to mask), and 51 - it will be reverted in driver automatically. so that the user can just specify 52 - axi_id to monitor a specific id, rather than having to specify axi_mask. 53 - e.g.:: 54 - perf stat -a -e imx8_ddr0/axid-read,axi_id=0x12/ cmd, which will monitor ARID=0x12 46 + .. code-block:: bash 47 + 48 + perf stat -a -e imx8_ddr0/axid-read,axi_mask=0xMMMM,axi_id=0xDDDD/ cmd 49 + perf stat -a -e imx8_ddr0/axid-write,axi_mask=0xMMMM,axi_id=0xDDDD/ cmd 50 + 51 + .. note:: 52 + 53 + axi_mask is inverted in userspace(i.e. set bits are bits to mask), and 54 + it will be reverted in driver automatically. so that the user can just specify 55 + axi_id to monitor a specific id, rather than having to specify axi_mask. 56 + 57 + .. code-block:: bash 58 + 59 + perf stat -a -e imx8_ddr0/axid-read,axi_id=0x12/ cmd, which will monitor ARID=0x12
+1
Documentation/admin-guide/perf/index.rst
··· 8 8 :maxdepth: 1 9 9 10 10 hisi-pmu 11 + imx-ddr 11 12 qcom_l2_pmu 12 13 qcom_l3_pmu 13 14 arm-ccn