Re: [PATCH 31/32] Documentation: ABI + trace: hisi_ptt: update paths to bus/event_source

[Yicong Yang]

On 2023/4/4 21:42, Jonathan Cameron wrote:
> To allow for assigning a suitable parent to the struct pmu device
> update the documentation to describe the device via the event_source
> bus where it will remain accessible.
> 
> For the ABI documention file also rename the file as it is named
> after the path.
> 
> Signed-off-by: Jonathan Cameron <Jonathan.Cameron@xxxxxxxxxx>

Reviewed-by: Yicong Yang <yangyicong@xxxxxxxxxxxxx>

> ---
>  ...i_ptt => sysfs-bus-event_source-devices-hisi_ptt} | 12 ++++++------
>  Documentation/trace/hisi-ptt.rst                     |  4 ++--
>  MAINTAINERS                                          |  2 +-
>  3 files changed, 9 insertions(+), 9 deletions(-)
> 
> diff --git a/Documentation/ABI/testing/sysfs-devices-hisi_ptt b/Documentation/ABI/testing/sysfs-bus-event_source-devices-hisi_ptt
> similarity index 83%
> rename from Documentation/ABI/testing/sysfs-devices-hisi_ptt
> rename to Documentation/ABI/testing/sysfs-bus-event_source-devices-hisi_ptt
> index 82de6d710266..f2f48f7ce887 100644
> --- a/Documentation/ABI/testing/sysfs-devices-hisi_ptt
> +++ b/Documentation/ABI/testing/sysfs-bus-event_source-devices-hisi_ptt
> @@ -1,4 +1,4 @@
> -What:		/sys/devices/hisi_ptt<sicl_id>_<core_id>/tune
> +What:		/sys/bus/event_source/devices/hisi_ptt<sicl_id>_<core_id>/tune
>  Date:		October 2022
>  KernelVersion:	6.1
>  Contact:	Yicong Yang <yangyicong@xxxxxxxxxxxxx>
> @@ -8,7 +8,7 @@ Description:	This directory contains files for tuning the PCIe link
>  
>  		See Documentation/trace/hisi-ptt.rst for more information.
>  
> -What:		/sys/devices/hisi_ptt<sicl_id>_<core_id>/tune/qos_tx_cpl
> +What:		/sys/bus/event_source/devices/hisi_ptt<sicl_id>_<core_id>/tune/qos_tx_cpl
>  Date:		October 2022
>  KernelVersion:	6.1
>  Contact:	Yicong Yang <yangyicong@xxxxxxxxxxxxx>
> @@ -18,7 +18,7 @@ Description:	(RW) Controls the weight of Tx completion TLPs, which influence
>  		will return an error, and out of range values will be converted
>  		to 2. The value indicates a probable level of the event.
>  
> -What:		/sys/devices/hisi_ptt<sicl_id>_<core_id>/tune/qos_tx_np
> +What:		/sys/bus/event_source/devices/hisi_ptt<sicl_id>_<core_id>/tune/qos_tx_np
>  Date:		October 2022
>  KernelVersion:	6.1
>  Contact:	Yicong Yang <yangyicong@xxxxxxxxxxxxx>
> @@ -28,7 +28,7 @@ Description:	(RW) Controls the weight of Tx non-posted TLPs, which influence
>  		will return an error, and out of range values will be converted
>  		to 2. The value indicates a probable level of the event.
>  
> -What:		/sys/devices/hisi_ptt<sicl_id>_<core_id>/tune/qos_tx_p
> +What:		/sys/bus/event_source/devices/hisi_ptt<sicl_id>_<core_id>/tune/qos_tx_p
>  Date:		October 2022
>  KernelVersion:	6.1
>  Contact:	Yicong Yang <yangyicong@xxxxxxxxxxxxx>
> @@ -38,7 +38,7 @@ Description:	(RW) Controls the weight of Tx posted TLPs, which influence the
>  		will return an error, and out of range values will be converted
>  		to 2. The value indicates a probable level of the event.
>  
> -What:		/sys/devices/hisi_ptt<sicl_id>_<core_id>/tune/rx_alloc_buf_level
> +What:		/sys/bus/event_source/devices/hisi_ptt<sicl_id>_<core_id>/tune/rx_alloc_buf_level
>  Date:		October 2022
>  KernelVersion:	6.1
>  Contact:	Yicong Yang <yangyicong@xxxxxxxxxxxxx>
> @@ -49,7 +49,7 @@ Description:	(RW) Control the allocated buffer watermark for inbound packets.
>  		will return an error, and out of range values will be converted
>  		to 2. The value indicates a probable level of the event.
>  
> -What:		/sys/devices/hisi_ptt<sicl_id>_<core_id>/tune/tx_alloc_buf_level
> +What:		/sys/bus/event_source/devices/hisi_ptt<sicl_id>_<core_id>/tune/tx_alloc_buf_level
>  Date:		October 2022
>  KernelVersion:	6.1
>  Contact:	Yicong Yang <yangyicong@xxxxxxxxxxxxx>
> diff --git a/Documentation/trace/hisi-ptt.rst b/Documentation/trace/hisi-ptt.rst
> index 4f87d8e21065..d923e09fcbaa 100644
> --- a/Documentation/trace/hisi-ptt.rst
> +++ b/Documentation/trace/hisi-ptt.rst
> @@ -40,7 +40,7 @@ IO dies (SICL, Super I/O Cluster), where there's one PCIe Root
>  Complex for each SICL.
>  ::
>  
> -    /sys/devices/hisi_ptt<sicl_id>_<core_id>
> +    /sys/bus/event_source/devices/hisi_ptt<sicl_id>_<core_id>
>  
>  Tune
>  ====
> @@ -53,7 +53,7 @@ Each event is presented as a file under $(PTT PMU dir)/tune, and
>  a simple open/read/write/close cycle will be used to tune the event.
>  ::
>  
> -    $ cd /sys/devices/hisi_ptt<sicl_id>_<core_id>/tune
> +    $ cd /sys/bus/event_source/devices/hisi_ptt<sicl_id>_<core_id>/tune
>      $ ls
>      qos_tx_cpl    qos_tx_np    qos_tx_p
>      tx_path_rx_req_alloc_buf_level
> diff --git a/MAINTAINERS b/MAINTAINERS
> index d8ebab595b2a..75019f62b1df 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -9266,7 +9266,7 @@ M:	Yicong Yang <yangyicong@xxxxxxxxxxxxx>
>  M:	Jonathan Cameron <jonathan.cameron@xxxxxxxxxx>
>  L:	linux-kernel@xxxxxxxxxxxxxxx
>  S:	Maintained
> -F:	Documentation/ABI/testing/sysfs-devices-hisi_ptt
> +F:	Documentation/ABI/testing/sysfs-bus-event_source-devices-hisi_ptt
>  F:	Documentation/trace/hisi-ptt.rst
>  F:	drivers/hwtracing/ptt/
>  F:	tools/perf/arch/arm64/util/hisi-ptt.c
>