From: Jonathan Cameron <Jonathan.Cameron@Huawei.com> To: Yicong Yang <yangyicong@huawei.com> Cc: Shaokun Zhang <zhangshaokun@hisilicon.com>, <liuqi6124@gmail.com>, Jonathan Corbet <corbet@lwn.net>, Will Deacon <will@kernel.org>, "Mark Rutland" <mark.rutland@arm.com>, <bagasdotme@gmail.com>, <linux-kernel@vger.kernel.org>, <linux-arm-kernel@lists.infradead.org>, <linux-doc@vger.kernel.org>, <linux-pci@vger.kernel.org>, <linuxarm@huawei.com>, <f.fangjian@huawei.com>, <prime.zeng@huawei.com>, <shenyang39@huawei.com> Subject: Re: [PATCH v2 4/4] Documentation: perf: Indent filter options list of hisi-pcie-pmu Date: Fri, 11 Nov 2022 11:02:00 +0000 [thread overview] Message-ID: <20221111110200.000047fd@Huawei.com> (raw) In-Reply-To: <20221110085109.45227-5-yangyicong@huawei.com> On Thu, 10 Nov 2022 16:51:09 +0800 Yicong Yang <yangyicong@huawei.com> wrote: > From: Bagas Sanjaya <bagasdotme@gmail.com> > > The "Filter options" list have a rather ugly indentation. Also, the first > paragraph after list name is rendered without separator (as continuation > from the name). > > Align the list by indenting the list items and add a blank line > separator for each list name. > > Fixes: c8602008e247 ("docs: perf: Add description for HiSilicon PCIe PMU driver") > Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com> Annoying though it is to do, this should be a precusors to the changes added earlier in this series - or drop the fixes tag. I'd argue that 'ugly' isn't something that we need to potentially backport fixes to. Change itself looks fine though. > --- > .../admin-guide/perf/hisi-pcie-pmu.rst | 80 ++++++++++--------- > 1 file changed, 43 insertions(+), 37 deletions(-) > > diff --git a/Documentation/admin-guide/perf/hisi-pcie-pmu.rst b/Documentation/admin-guide/perf/hisi-pcie-pmu.rst > index b3615230a4f6..7e863662e2d4 100644 > --- a/Documentation/admin-guide/perf/hisi-pcie-pmu.rst > +++ b/Documentation/admin-guide/perf/hisi-pcie-pmu.rst > @@ -48,62 +48,68 @@ Filter options > -------------- > > 1. Target filter > -PMU could only monitor the performance of traffic downstream target Root Ports > -or downstream target Endpoint. PCIe PMU driver support "port" and "bdf" > -interfaces for users, and these two interfaces aren't supported at the same > -time. > > --port > -"port" filter can be used in all PCIe PMU events, target Root Port can be > -selected by configuring the 16-bits-bitmap "port". Multi ports can be selected > -for AP-layer-events, and only one port can be selected for TL/DL-layer-events. > + PMU could only monitor the performance of traffic downstream target Root > + Ports or downstream target Endpoint. PCIe PMU driver support "port" and > + "bdf" interfaces for users, and these two interfaces aren't supported at the > + same time. > > -For example, if target Root Port is 0000:00:00.0 (x8 lanes), bit0 of bitmap > -should be set, port=0x1; if target Root Port is 0000:00:04.0 (x4 lanes), > -bit8 is set, port=0x100; if these two Root Ports are both monitored, port=0x101. > + - port > > -Example usage of perf:: > + "port" filter can be used in all PCIe PMU events, target Root Port can be > + selected by configuring the 16-bits-bitmap "port". Multi ports can be > + selected for AP-layer-events, and only one port can be selected for > + TL/DL-layer-events. > > - $# perf stat -e hisi_pcie0_core0/rx_mwr_latency,port=0x1/ sleep 5 > + For example, if target Root Port is 0000:00:00.0 (x8 lanes), bit0 of > + bitmap should be set, port=0x1; if target Root Port is 0000:00:04.0 (x4 > + lanes), bit8 is set, port=0x100; if these two Root Ports are both > + monitored, port=0x101. > > --bdf > + Example usage of perf:: > > -"bdf" filter can only be used in bandwidth events, target Endpoint is selected > -by configuring BDF to "bdf". Counter only counts the bandwidth of message > -requested by target Endpoint. > + $# perf stat -e hisi_pcie0_core0/rx_mwr_latency,port=0x1/ sleep 5 > > -For example, "bdf=0x3900" means BDF of target Endpoint is 0000:39:00.0. > + - bdf > > -Example usage of perf:: > + "bdf" filter can only be used in bandwidth events, target Endpoint is > + selected by configuring BDF to "bdf". Counter only counts the bandwidth of > + message requested by target Endpoint. > + > + For example, "bdf=0x3900" means BDF of target Endpoint is 0000:39:00.0. > > - $# perf stat -e hisi_pcie0_core0/rx_mrd_flux,bdf=0x3900/ sleep 5 > + Example usage of perf:: > + > + $# perf stat -e hisi_pcie0_core0/rx_mrd_flux,bdf=0x3900/ sleep 5 > > 2. Trigger filter > -Event statistics start when the first time TLP length is greater/smaller > -than trigger condition. You can set the trigger condition by writing "trig_len", > -and set the trigger mode by writing "trig_mode". This filter can only be used > -in bandwidth events. > > -For example, "trig_len=4" means trigger condition is 2^4 DW, "trig_mode=0" > -means statistics start when TLP length > trigger condition, "trig_mode=1" > -means start when TLP length < condition. > + Event statistics start when the first time TLP length is greater/smaller > + than trigger condition. You can set the trigger condition by writing > + "trig_len", and set the trigger mode by writing "trig_mode". This filter can > + only be used in bandwidth events. > > -Example usage of perf:: > + For example, "trig_len=4" means trigger condition is 2^4 DW, "trig_mode=0" > + means statistics start when TLP length > trigger condition, "trig_mode=1" > + means start when TLP length < condition. > > - $# perf stat -e hisi_pcie0_core0/rx_mrd_flux,trig_len=0x4,trig_mode=1/ sleep 5 > + Example usage of perf:: > + > + $# perf stat -e hisi_pcie0_core0/rx_mrd_flux,trig_len=0x4,trig_mode=1/ sleep 5 > > 3. Threshold filter > -Counter counts when TLP length within the specified range. You can set the > -threshold by writing "thr_len", and set the threshold mode by writing > -"thr_mode". This filter can only be used in bandwidth events. > > -For example, "thr_len=4" means threshold is 2^4 DW, "thr_mode=0" means > -counter counts when TLP length >= threshold, and "thr_mode=1" means counts > -when TLP length < threshold. > + Counter counts when TLP length within the specified range. You can set the > + threshold by writing "thr_len", and set the threshold mode by writing > + "thr_mode". This filter can only be used in bandwidth events. > > -Example usage of perf:: > + For example, "thr_len=4" means threshold is 2^4 DW, "thr_mode=0" means > + counter counts when TLP length >= threshold, and "thr_mode=1" means counts > + when TLP length < threshold. > + > + Example usage of perf:: > > - $# perf stat -e hisi_pcie0_core0/rx_mrd_flux,thr_len=0x4,thr_mode=1/ sleep 5 > + $# perf stat -e hisi_pcie0_core0/rx_mrd_flux,thr_len=0x4,thr_mode=1/ sleep 5 > > 4. TLP Length filter >
WARNING: multiple messages have this Message-ID (diff)
From: Jonathan Cameron <Jonathan.Cameron@Huawei.com> To: Yicong Yang <yangyicong@huawei.com> Cc: Shaokun Zhang <zhangshaokun@hisilicon.com>, <liuqi6124@gmail.com>, Jonathan Corbet <corbet@lwn.net>, Will Deacon <will@kernel.org>, "Mark Rutland" <mark.rutland@arm.com>, <bagasdotme@gmail.com>, <linux-kernel@vger.kernel.org>, <linux-arm-kernel@lists.infradead.org>, <linux-doc@vger.kernel.org>, <linux-pci@vger.kernel.org>, <linuxarm@huawei.com>, <f.fangjian@huawei.com>, <prime.zeng@huawei.com>, <shenyang39@huawei.com> Subject: Re: [PATCH v2 4/4] Documentation: perf: Indent filter options list of hisi-pcie-pmu Date: Fri, 11 Nov 2022 11:02:24 +0000 [thread overview] Message-ID: <20221111110200.000047fd@Huawei.com> (raw) Message-ID: <20221111110224.giKU5lRE2CEhozNY0zTwzqJ7bPbLoVmXZYYAYnrCGQE@z> (raw) In-Reply-To: <20221110085109.45227-5-yangyicong@huawei.com> On Thu, 10 Nov 2022 16:51:09 +0800 Yicong Yang <yangyicong@huawei.com> wrote: > From: Bagas Sanjaya <bagasdotme@gmail.com> > > The "Filter options" list have a rather ugly indentation. Also, the first > paragraph after list name is rendered without separator (as continuation > from the name). > > Align the list by indenting the list items and add a blank line > separator for each list name. > > Fixes: c8602008e247 ("docs: perf: Add description for HiSilicon PCIe PMU driver") > Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com> Annoying though it is to do, this should be a precusors to the changes added earlier in this series - or drop the fixes tag. I'd argue that 'ugly' isn't something that we need to potentially backport fixes to. Change itself looks fine though. FWIW Reviewed-by: Jonathan Cameron <Jonathan.Cameron@huawei.com> > --- > .../admin-guide/perf/hisi-pcie-pmu.rst | 80 ++++++++++--------- > 1 file changed, 43 insertions(+), 37 deletions(-) > > diff --git a/Documentation/admin-guide/perf/hisi-pcie-pmu.rst b/Documentation/admin-guide/perf/hisi-pcie-pmu.rst > index b3615230a4f6..7e863662e2d4 100644 > --- a/Documentation/admin-guide/perf/hisi-pcie-pmu.rst > +++ b/Documentation/admin-guide/perf/hisi-pcie-pmu.rst > @@ -48,62 +48,68 @@ Filter options > -------------- > > 1. Target filter > -PMU could only monitor the performance of traffic downstream target Root Ports > -or downstream target Endpoint. PCIe PMU driver support "port" and "bdf" > -interfaces for users, and these two interfaces aren't supported at the same > -time. > > --port > -"port" filter can be used in all PCIe PMU events, target Root Port can be > -selected by configuring the 16-bits-bitmap "port". Multi ports can be selected > -for AP-layer-events, and only one port can be selected for TL/DL-layer-events. > + PMU could only monitor the performance of traffic downstream target Root > + Ports or downstream target Endpoint. PCIe PMU driver support "port" and > + "bdf" interfaces for users, and these two interfaces aren't supported at the > + same time. > > -For example, if target Root Port is 0000:00:00.0 (x8 lanes), bit0 of bitmap > -should be set, port=0x1; if target Root Port is 0000:00:04.0 (x4 lanes), > -bit8 is set, port=0x100; if these two Root Ports are both monitored, port=0x101. > + - port > > -Example usage of perf:: > + "port" filter can be used in all PCIe PMU events, target Root Port can be > + selected by configuring the 16-bits-bitmap "port". Multi ports can be > + selected for AP-layer-events, and only one port can be selected for > + TL/DL-layer-events. > > - $# perf stat -e hisi_pcie0_core0/rx_mwr_latency,port=0x1/ sleep 5 > + For example, if target Root Port is 0000:00:00.0 (x8 lanes), bit0 of > + bitmap should be set, port=0x1; if target Root Port is 0000:00:04.0 (x4 > + lanes), bit8 is set, port=0x100; if these two Root Ports are both > + monitored, port=0x101. > > --bdf > + Example usage of perf:: > > -"bdf" filter can only be used in bandwidth events, target Endpoint is selected > -by configuring BDF to "bdf". Counter only counts the bandwidth of message > -requested by target Endpoint. > + $# perf stat -e hisi_pcie0_core0/rx_mwr_latency,port=0x1/ sleep 5 > > -For example, "bdf=0x3900" means BDF of target Endpoint is 0000:39:00.0. > + - bdf > > -Example usage of perf:: > + "bdf" filter can only be used in bandwidth events, target Endpoint is > + selected by configuring BDF to "bdf". Counter only counts the bandwidth of > + message requested by target Endpoint. > + > + For example, "bdf=0x3900" means BDF of target Endpoint is 0000:39:00.0. > > - $# perf stat -e hisi_pcie0_core0/rx_mrd_flux,bdf=0x3900/ sleep 5 > + Example usage of perf:: > + > + $# perf stat -e hisi_pcie0_core0/rx_mrd_flux,bdf=0x3900/ sleep 5 > > 2. Trigger filter > -Event statistics start when the first time TLP length is greater/smaller > -than trigger condition. You can set the trigger condition by writing "trig_len", > -and set the trigger mode by writing "trig_mode". This filter can only be used > -in bandwidth events. > > -For example, "trig_len=4" means trigger condition is 2^4 DW, "trig_mode=0" > -means statistics start when TLP length > trigger condition, "trig_mode=1" > -means start when TLP length < condition. > + Event statistics start when the first time TLP length is greater/smaller > + than trigger condition. You can set the trigger condition by writing > + "trig_len", and set the trigger mode by writing "trig_mode". This filter can > + only be used in bandwidth events. > > -Example usage of perf:: > + For example, "trig_len=4" means trigger condition is 2^4 DW, "trig_mode=0" > + means statistics start when TLP length > trigger condition, "trig_mode=1" > + means start when TLP length < condition. > > - $# perf stat -e hisi_pcie0_core0/rx_mrd_flux,trig_len=0x4,trig_mode=1/ sleep 5 > + Example usage of perf:: > + > + $# perf stat -e hisi_pcie0_core0/rx_mrd_flux,trig_len=0x4,trig_mode=1/ sleep 5 > > 3. Threshold filter > -Counter counts when TLP length within the specified range. You can set the > -threshold by writing "thr_len", and set the threshold mode by writing > -"thr_mode". This filter can only be used in bandwidth events. > > -For example, "thr_len=4" means threshold is 2^4 DW, "thr_mode=0" means > -counter counts when TLP length >= threshold, and "thr_mode=1" means counts > -when TLP length < threshold. > + Counter counts when TLP length within the specified range. You can set the > + threshold by writing "thr_len", and set the threshold mode by writing > + "thr_mode". This filter can only be used in bandwidth events. > > -Example usage of perf:: > + For example, "thr_len=4" means threshold is 2^4 DW, "thr_mode=0" means > + counter counts when TLP length >= threshold, and "thr_mode=1" means counts > + when TLP length < threshold. > + > + Example usage of perf:: > > - $# perf stat -e hisi_pcie0_core0/rx_mrd_flux,thr_len=0x4,thr_mode=1/ sleep 5 > + $# perf stat -e hisi_pcie0_core0/rx_mrd_flux,thr_len=0x4,thr_mode=1/ sleep 5 > > 4. TLP Length filter >
next prev parent reply other threads:[~2022-11-11 11:02 UTC|newest] Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top 2022-11-10 8:51 [PATCH v2 0/4] Add TLP filter support and some fixes for HiSilicon PCIe PMU Yicong Yang 2022-11-10 8:51 ` [PATCH v2 1/4] drivers/perf: hisi: Fix some event id for hisi-pcie-pmu Yicong Yang 2022-11-10 8:51 ` [PATCH v2 2/4] docs: perf: Fix PMU instance name of hisi-pcie-pmu Yicong Yang 2022-11-10 8:51 ` [PATCH v2 3/4] drivers/perf: hisi: Add TLP filter support Yicong Yang 2022-11-11 10:58 ` Jonathan Cameron 2022-11-10 8:51 ` [PATCH v2 4/4] Documentation: perf: Indent filter options list of hisi-pcie-pmu Yicong Yang 2022-11-11 11:02 ` Jonathan Cameron [this message] 2022-11-11 11:02 ` Jonathan Cameron
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=20221111110200.000047fd@Huawei.com \ --to=jonathan.cameron@huawei.com \ --cc=bagasdotme@gmail.com \ --cc=corbet@lwn.net \ --cc=f.fangjian@huawei.com \ --cc=linux-arm-kernel@lists.infradead.org \ --cc=linux-doc@vger.kernel.org \ --cc=linux-kernel@vger.kernel.org \ --cc=linux-pci@vger.kernel.org \ --cc=linuxarm@huawei.com \ --cc=liuqi6124@gmail.com \ --cc=mark.rutland@arm.com \ --cc=prime.zeng@huawei.com \ --cc=shenyang39@huawei.com \ --cc=will@kernel.org \ --cc=yangyicong@huawei.com \ --cc=zhangshaokun@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: linkBe 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).