Re: [PATCH v2 06/10] docs: ABI: sysfs-bus-event_source-devices-hv_gpci: Document affinity_domain_via_virtual_processor sysfs interface file

2023-07-11 Thread Randy Dunlap
Hi--

On 7/10/23 02:27, Kajol Jain wrote:
> Add details of the new hv-gpci interface file called
> "affinity_domain_via_virtual_processor" in the ABI documentation.
> 
> Signed-off-by: Kajol Jain 
> ---
>  .../sysfs-bus-event_source-devices-hv_gpci| 32 +++
>  1 file changed, 32 insertions(+)
> 
> diff --git a/Documentation/ABI/testing/sysfs-bus-event_source-devices-hv_gpci 
> b/Documentation/ABI/testing/sysfs-bus-event_source-devices-hv_gpci
> index aff52dc3b05c..3b63d66658fe 100644
> --- a/Documentation/ABI/testing/sysfs-bus-event_source-devices-hv_gpci
> +++ b/Documentation/ABI/testing/sysfs-bus-event_source-devices-hv_gpci
> @@ -144,3 +144,35 @@ Description: admin read only
>  more information.
>  
>   * "-EFBIG" : System information exceeds PAGE_SIZE.
> +
> +What:
> /sys/devices/hv_gpci/interface/affinity_domain_via_virtual_processor
> +Date:July 2023
> +Contact: Linux on PowerPC Developer List 
> +Description: admin read only
> + This sysfs file exposes the system topology information by 
> making HCALL
> + H_GET_PERF_COUNTER_INFO. The HCALL is made with counter request 
> value
> + AFFINITY_DOMAIN_INFORMATION_BY_VIRTUAL_PROCESSOR(0xA0).
> +
> + * This sysfs file will be created only for power10 and above 
> platforms.
> +
> + * User needs root privileges to read data from this sysfs file.
> +
> + * This sysfs file will be created, only when the HCALL returns 
> "H_SUCESS",


H_SUCCESS

> +   "H_AUTHORITY" and "H_PARAMETER" as the return type.

s/and/or/

> +
> +   HCALL with return error type "H_AUTHORITY", can be resolved 
> during

Drop the comma: ^

> +   runtime by setting "Enable Performance Information 
> Collection" option.
> +
> + * The end user reading this sysfs file must decode the content 
> as per
> +   underlying platform/firmware.
> +
> + Possible error codes while reading this sysfs file:
> +
> + * "-EPERM" : Partition is not permitted to retrieve performance 
> information,
> + required to set "Enable Performance Information 
> Collection" option.
> +
> + * "-EIO" : Can't retrieve system information because of invalid 
> buffer length/invalid address
> +or because of some hardware error. Refer 
> getPerfCountInfo documentation for

  Refer to

> +more information.
> +
> + * "-EFBIG" : System information exceeds PAGE_SIZE.

-- 
~Randy


[PATCH v2 06/10] docs: ABI: sysfs-bus-event_source-devices-hv_gpci: Document affinity_domain_via_virtual_processor sysfs interface file

2023-07-10 Thread Kajol Jain
Add details of the new hv-gpci interface file called
"affinity_domain_via_virtual_processor" in the ABI documentation.

Signed-off-by: Kajol Jain 
---
 .../sysfs-bus-event_source-devices-hv_gpci| 32 +++
 1 file changed, 32 insertions(+)

diff --git a/Documentation/ABI/testing/sysfs-bus-event_source-devices-hv_gpci 
b/Documentation/ABI/testing/sysfs-bus-event_source-devices-hv_gpci
index aff52dc3b05c..3b63d66658fe 100644
--- a/Documentation/ABI/testing/sysfs-bus-event_source-devices-hv_gpci
+++ b/Documentation/ABI/testing/sysfs-bus-event_source-devices-hv_gpci
@@ -144,3 +144,35 @@ Description:   admin read only
   more information.
 
* "-EFBIG" : System information exceeds PAGE_SIZE.
+
+What:  
/sys/devices/hv_gpci/interface/affinity_domain_via_virtual_processor
+Date:  July 2023
+Contact:   Linux on PowerPC Developer List 
+Description:   admin read only
+   This sysfs file exposes the system topology information by 
making HCALL
+   H_GET_PERF_COUNTER_INFO. The HCALL is made with counter request 
value
+   AFFINITY_DOMAIN_INFORMATION_BY_VIRTUAL_PROCESSOR(0xA0).
+
+   * This sysfs file will be created only for power10 and above 
platforms.
+
+   * User needs root privileges to read data from this sysfs file.
+
+   * This sysfs file will be created, only when the HCALL returns 
"H_SUCESS",
+ "H_AUTHORITY" and "H_PARAMETER" as the return type.
+
+ HCALL with return error type "H_AUTHORITY", can be resolved 
during
+ runtime by setting "Enable Performance Information 
Collection" option.
+
+   * The end user reading this sysfs file must decode the content 
as per
+ underlying platform/firmware.
+
+   Possible error codes while reading this sysfs file:
+
+   * "-EPERM" : Partition is not permitted to retrieve performance 
information,
+   required to set "Enable Performance Information 
Collection" option.
+
+   * "-EIO" : Can't retrieve system information because of invalid 
buffer length/invalid address
+  or because of some hardware error. Refer 
getPerfCountInfo documentation for
+  more information.
+
+   * "-EFBIG" : System information exceeds PAGE_SIZE.
-- 
2.31.1