[PATCH v2] drm/hwmon: Fix abi doc warnings
This fixes warnings in xe, i915 hwmon docs
Warning: /sys/devices/.../hwmon/hwmon/curr1_crit is defined 2 times:
Documentation/ABI/testing/sysfs-driver-intel-xe-hwmon:35
Documentation/ABI/testing/sysfs-driver-intel-i915-hwmon:52
Warning: /sys/devices/.../hwmon/hwmon/energy1_input is defined 2 times:
Documentation/ABI/testing/sysfs-driver-intel-xe-hwmon:54
Documentation/ABI/testing/sysfs-driver-intel-i915-hwmon:65
Warning: /sys/devices/.../hwmon/hwmon/in0_input is defined 2 times:
Documentation/ABI/testing/sysfs-driver-intel-xe-hwmon:46
Documentation/ABI/testing/sysfs-driver-intel-i915-hwmon:0
Warning: /sys/devices/.../hwmon/hwmon/power1_crit is defined 2 times:
Documentation/ABI/testing/sysfs-driver-intel-xe-hwmon:22
Documentation/ABI/testing/sysfs-driver-intel-i915-hwmon:39
Warning: /sys/devices/.../hwmon/hwmon/power1_max is defined 2 times:
Documentation/ABI/testing/sysfs-driver-intel-xe-hwmon:0
Documentation/ABI/testing/sysfs-driver-intel-i915-hwmon:8
Warning: /sys/devices/.../hwmon/hwmon/power1_max_interval is defined 2
times: Documentation/ABI/testing/sysfs-driver-intel-xe-hwmon:62
Documentation/ABI/testing/sysfs-driver-intel-i915-hwmon:30
Warning: /sys/devices/.../hwmon/hwmon/power1_rated_max is defined 2 times:
Documentation/ABI/testing/sysfs-driver-intel-xe-hwmon:14
Documentation/ABI/testing/sysfs-driver-intel-i915-hwmon:22
Fixes: fb1b70607f73 ("drm/xe/hwmon: Expose power attributes")
Fixes: 92d44a422d0d ("drm/xe/hwmon: Expose card reactive critical power")
Fixes: fbcdc9d3bf58 ("drm/xe/hwmon: Expose input voltage attribute")
Fixes: 71d0a32524f9 ("drm/xe/hwmon: Expose hwmon energy attribute")
Fixes: 4446fcf220ce ("drm/xe/hwmon: Expose power1_max_interval")
Fixes: f8572bb67525 ("drm/i915/hwmon: Add HWMON current voltage support")
Fixes: 99f55efb7911 ("drm/i915/hwmon: Power PL1 limit and TDP setting")
Fixes: 4c2572fe0ae7 ("drm/i915/hwmon: Expose power1_max_interval")
Fixes: c8939848f7e4 ("drm/i915/hwmon: Expose card reactive critical power")
Fixes: c41b8bdcc297 ("drm/i915/hwmon: Show device level energy usage")
Cc: Ashutosh Dixit
Cc: Lucas Demarchi
Cc: Rodrigo Vivi
Reported-by: Stephen Rothwell
Closes: https://lore.kernel.org/all/20240125113345.29111...@canb.auug.org.au/
Signed-off-by: Badal Nilawar
---
.../ABI/testing/sysfs-driver-intel-i915-hwmon | 14 +++---
.../ABI/testing/sysfs-driver-intel-xe-hwmon| 14 +++---
2 files changed, 14 insertions(+), 14 deletions(-)
diff --git a/Documentation/ABI/testing/sysfs-driver-intel-i915-hwmon
b/Documentation/ABI/testing/sysfs-driver-intel-i915-hwmon
index 8d7d8f05f6cd..92fe7c5c5ac1 100644
--- a/Documentation/ABI/testing/sysfs-driver-intel-i915-hwmon
+++ b/Documentation/ABI/testing/sysfs-driver-intel-i915-hwmon
@@ -1,4 +1,4 @@
-What: /sys/devices/.../hwmon/hwmon/in0_input
+What: /sys/bus/pci/drivers/i915/.../hwmon/hwmon/in0_input
Date: February 2023
KernelVersion: 6.2
Contact: intel-gfx@lists.freedesktop.org
@@ -6,7 +6,7 @@ Description:RO. Current Voltage in millivolt.
Only supported for particular Intel i915 graphics platforms.
-What: /sys/devices/.../hwmon/hwmon/power1_max
+What: /sys/bus/pci/drivers/i915/.../hwmon/hwmon/power1_max
Date: February 2023
KernelVersion: 6.2
Contact: intel-gfx@lists.freedesktop.org
@@ -20,7 +20,7 @@ Description: RW. Card reactive sustained (PL1/Tau) power
limit in microwatts.
Only supported for particular Intel i915 graphics platforms.
-What: /sys/devices/.../hwmon/hwmon/power1_rated_max
+What: /sys/bus/pci/drivers/i915/.../hwmon/hwmon/power1_rated_max
Date: February 2023
KernelVersion: 6.2
Contact: intel-gfx@lists.freedesktop.org
@@ -28,7 +28,7 @@ Description: RO. Card default power limit (default TDP
setting).
Only supported for particular Intel i915 graphics platforms.
-What: /sys/devices/.../hwmon/hwmon/power1_max_interval
+What: /sys/bus/pci/drivers/i915/.../hwmon/hwmon/power1_max_interval
Date: February 2023
KernelVersion: 6.2
Contact: intel-gfx@lists.freedesktop.org
@@ -37,7 +37,7 @@ Description: RW. Sustained power limit interval (Tau in
PL1/Tau) in
Only supported for particular Intel i915 graphics platforms.
-What: /sys/devices/.../hwmon/hwmon/power1_crit
+What: /sys/bus/pci/drivers/i915/.../hwmon/hwmon/power1_crit
Date: February 2023
KernelVersion: 6.2
Contact: intel-gfx@lists.freedesktop.org
@@ -50,7 +50,7 @@ Description: RW. Card reactive critical (I1) power limit in
microwatts.
Only supported for particular Intel i915 graphics platforms.
-What: /sys/devices/.../hwmon/hwmon/curr1_crit
+What: /sys/bus/pci/drivers/i915/.../hwmon/hwmon/curr1_crit
Date: February 2023
KernelVersion: 6.2
Contact: intel-gfx@lists.freedesktop.org
@@ -63,7
Re: [PATCH v2] drm/hwmon: Fix abi doc warnings
On Sat, 27 Jan 2024 08:50:40 -0800, Badal Nilawar wrote: > Hi Badal, > This fixes warnings in xe, i915 hwmon docs > > Warning: /sys/devices/.../hwmon/hwmon/curr1_crit is defined 2 times: > Documentation/ABI/testing/sysfs-driver-intel-xe-hwmon:35 > Documentation/ABI/testing/sysfs-driver-intel-i915-hwmon:52 > Warning: /sys/devices/.../hwmon/hwmon/energy1_input is defined 2 times: > Documentation/ABI/testing/sysfs-driver-intel-xe-hwmon:54 > Documentation/ABI/testing/sysfs-driver-intel-i915-hwmon:65 > Warning: /sys/devices/.../hwmon/hwmon/in0_input is defined 2 times: > Documentation/ABI/testing/sysfs-driver-intel-xe-hwmon:46 > Documentation/ABI/testing/sysfs-driver-intel-i915-hwmon:0 > Warning: /sys/devices/.../hwmon/hwmon/power1_crit is defined 2 times: > Documentation/ABI/testing/sysfs-driver-intel-xe-hwmon:22 > Documentation/ABI/testing/sysfs-driver-intel-i915-hwmon:39 > Warning: /sys/devices/.../hwmon/hwmon/power1_max is defined 2 times: > Documentation/ABI/testing/sysfs-driver-intel-xe-hwmon:0 > Documentation/ABI/testing/sysfs-driver-intel-i915-hwmon:8 > Warning: /sys/devices/.../hwmon/hwmon/power1_max_interval is defined 2 > times: Documentation/ABI/testing/sysfs-driver-intel-xe-hwmon:62 > Documentation/ABI/testing/sysfs-driver-intel-i915-hwmon:30 > Warning: /sys/devices/.../hwmon/hwmon/power1_rated_max is defined 2 times: > Documentation/ABI/testing/sysfs-driver-intel-xe-hwmon:14 > Documentation/ABI/testing/sysfs-driver-intel-i915-hwmon:22 /snip/ > diff --git a/Documentation/ABI/testing/sysfs-driver-intel-i915-hwmon > b/Documentation/ABI/testing/sysfs-driver-intel-i915-hwmon > index 8d7d8f05f6cd..92fe7c5c5ac1 100644 > --- a/Documentation/ABI/testing/sysfs-driver-intel-i915-hwmon > +++ b/Documentation/ABI/testing/sysfs-driver-intel-i915-hwmon > @@ -1,4 +1,4 @@ > -What:/sys/devices/.../hwmon/hwmon/in0_input Are the warnings happening because this path doesn't exist? > +What:/sys/bus/pci/drivers/i915/.../hwmon/hwmon/in0_input So this I guess could also be /sys/class/drm/card/device/hwmon/hwmon/in0_input? But no need to change, what you have is also a valid path. But maybe to make clear: /sys/bus/pci/drivers/i915//hwmon/hwmon/in0_input ? But anyway... Assuming you turned on the htmldoc build option, could reproduce this and verified that this patch is fixing these warnings, this is: Reviewed-by: Ashutosh Dixit
Re: [PATCH v2] drm/hwmon: Fix abi doc warnings
On Mon, 29 Jan 2024 07:18:59 -0800, Lucas De Marchi wrote: > > On Sat, Jan 27, 2024 at 12:10:08PM -0800, Ashutosh Dixit wrote: > > On Sat, 27 Jan 2024 08:50:40 -0800, Badal Nilawar wrote: > >> > > > > Hi Badal, > > > >> This fixes warnings in xe, i915 hwmon docs > >> > >> Warning: /sys/devices/.../hwmon/hwmon/curr1_crit is defined 2 times: > >> Documentation/ABI/testing/sysfs-driver-intel-xe-hwmon:35 > >> Documentation/ABI/testing/sysfs-driver-intel-i915-hwmon:52 > >> Warning: /sys/devices/.../hwmon/hwmon/energy1_input is defined 2 times: > >> Documentation/ABI/testing/sysfs-driver-intel-xe-hwmon:54 > >> Documentation/ABI/testing/sysfs-driver-intel-i915-hwmon:65 > >> Warning: /sys/devices/.../hwmon/hwmon/in0_input is defined 2 times: > >> Documentation/ABI/testing/sysfs-driver-intel-xe-hwmon:46 > >> Documentation/ABI/testing/sysfs-driver-intel-i915-hwmon:0 > >> Warning: /sys/devices/.../hwmon/hwmon/power1_crit is defined 2 times: > >> Documentation/ABI/testing/sysfs-driver-intel-xe-hwmon:22 > >> Documentation/ABI/testing/sysfs-driver-intel-i915-hwmon:39 > >> Warning: /sys/devices/.../hwmon/hwmon/power1_max is defined 2 times: > >> Documentation/ABI/testing/sysfs-driver-intel-xe-hwmon:0 > >> Documentation/ABI/testing/sysfs-driver-intel-i915-hwmon:8 > >> Warning: /sys/devices/.../hwmon/hwmon/power1_max_interval is defined 2 > >> times: Documentation/ABI/testing/sysfs-driver-intel-xe-hwmon:62 > >> Documentation/ABI/testing/sysfs-driver-intel-i915-hwmon:30 > >> Warning: /sys/devices/.../hwmon/hwmon/power1_rated_max is defined 2 > >> times: Documentation/ABI/testing/sysfs-driver-intel-xe-hwmon:14 > >> Documentation/ABI/testing/sysfs-driver-intel-i915-hwmon:22 > > > > /snip/ > > > >> diff --git a/Documentation/ABI/testing/sysfs-driver-intel-i915-hwmon > >> b/Documentation/ABI/testing/sysfs-driver-intel-i915-hwmon > >> index 8d7d8f05f6cd..92fe7c5c5ac1 100644 > >> --- a/Documentation/ABI/testing/sysfs-driver-intel-i915-hwmon > >> +++ b/Documentation/ABI/testing/sysfs-driver-intel-i915-hwmon > >> @@ -1,4 +1,4 @@ > >> -What: /sys/devices/.../hwmon/hwmon/in0_input > > > > Are the warnings happening because this path doesn't exist? > > > >> +What: /sys/bus/pci/drivers/i915/.../hwmon/hwmon/in0_input > > > > So this I guess could also be > > > > /sys/class/drm/card/device/hwmon/hwmon/in0_input? > > no. the issue is not that it doesn't exist, but that the same path is > documented in 2 different places. If the interface is exactly the same, > there could be just 1 place to document it and then reuse the same file > (without the module name). If the interfaces are not identical, then we > should differentiate them like is done here. Ah, got it, thanks! > > +i915 maintainers > > Are you ok with merging this through either xe or i915 trees > instead of splitting the patch? My preference is the first option. > > > Reviewed-by: Lucas De Marchi > > also tested that this fixes the issue when building docs. > > thanks > Lucas De Marchi > > > > > But no need to change, what you have is also a valid path. But maybe to > > make clear: > > > > /sys/bus/pci/drivers/i915//hwmon/hwmon/in0_input > > > > ? > > > > But anyway... > > > > Assuming you turned on the htmldoc build option, could reproduce this and > > verified that this patch is fixing these warnings, this is: > > > > Reviewed-by: Ashutosh Dixit
Re: Re: [PATCH v2] drm/hwmon: Fix abi doc warnings
On Sat, Jan 27, 2024 at 12:10:08PM -0800, Ashutosh Dixit wrote: On Sat, 27 Jan 2024 08:50:40 -0800, Badal Nilawar wrote: Hi Badal, This fixes warnings in xe, i915 hwmon docs Warning: /sys/devices/.../hwmon/hwmon/curr1_crit is defined 2 times: Documentation/ABI/testing/sysfs-driver-intel-xe-hwmon:35 Documentation/ABI/testing/sysfs-driver-intel-i915-hwmon:52 Warning: /sys/devices/.../hwmon/hwmon/energy1_input is defined 2 times: Documentation/ABI/testing/sysfs-driver-intel-xe-hwmon:54 Documentation/ABI/testing/sysfs-driver-intel-i915-hwmon:65 Warning: /sys/devices/.../hwmon/hwmon/in0_input is defined 2 times: Documentation/ABI/testing/sysfs-driver-intel-xe-hwmon:46 Documentation/ABI/testing/sysfs-driver-intel-i915-hwmon:0 Warning: /sys/devices/.../hwmon/hwmon/power1_crit is defined 2 times: Documentation/ABI/testing/sysfs-driver-intel-xe-hwmon:22 Documentation/ABI/testing/sysfs-driver-intel-i915-hwmon:39 Warning: /sys/devices/.../hwmon/hwmon/power1_max is defined 2 times: Documentation/ABI/testing/sysfs-driver-intel-xe-hwmon:0 Documentation/ABI/testing/sysfs-driver-intel-i915-hwmon:8 Warning: /sys/devices/.../hwmon/hwmon/power1_max_interval is defined 2 times: Documentation/ABI/testing/sysfs-driver-intel-xe-hwmon:62 Documentation/ABI/testing/sysfs-driver-intel-i915-hwmon:30 Warning: /sys/devices/.../hwmon/hwmon/power1_rated_max is defined 2 times: Documentation/ABI/testing/sysfs-driver-intel-xe-hwmon:14 Documentation/ABI/testing/sysfs-driver-intel-i915-hwmon:22 /snip/ diff --git a/Documentation/ABI/testing/sysfs-driver-intel-i915-hwmon b/Documentation/ABI/testing/sysfs-driver-intel-i915-hwmon index 8d7d8f05f6cd..92fe7c5c5ac1 100644 --- a/Documentation/ABI/testing/sysfs-driver-intel-i915-hwmon +++ b/Documentation/ABI/testing/sysfs-driver-intel-i915-hwmon @@ -1,4 +1,4 @@ -What: /sys/devices/.../hwmon/hwmon/in0_input Are the warnings happening because this path doesn't exist? +What: /sys/bus/pci/drivers/i915/.../hwmon/hwmon/in0_input So this I guess could also be /sys/class/drm/card/device/hwmon/hwmon/in0_input? no. the issue is not that it doesn't exist, but that the same path is documented in 2 different places. If the interface is exactly the same, there could be just 1 place to document it and then reuse the same file (without the module name). If the interfaces are not identical, then we should differentiate them like is done here. +i915 maintainers Are you ok with merging this through either xe or i915 trees instead of splitting the patch? My preference is the first option. Reviewed-by: Lucas De Marchi also tested that this fixes the issue when building docs. thanks Lucas De Marchi But no need to change, what you have is also a valid path. But maybe to make clear: /sys/bus/pci/drivers/i915//hwmon/hwmon/in0_input ? But anyway... Assuming you turned on the htmldoc build option, could reproduce this and verified that this patch is fixing these warnings, this is: Reviewed-by: Ashutosh Dixit
Re: Re: [PATCH v2] drm/hwmon: Fix abi doc warnings
On Mon, Jan 29, 2024 at 09:18:59AM -0600, Lucas De Marchi wrote: > On Sat, Jan 27, 2024 at 12:10:08PM -0800, Ashutosh Dixit wrote: > > On Sat, 27 Jan 2024 08:50:40 -0800, Badal Nilawar wrote: > > > > > > > Hi Badal, > > > > > This fixes warnings in xe, i915 hwmon docs > > > > > > Warning: /sys/devices/.../hwmon/hwmon/curr1_crit is defined 2 times: > > > Documentation/ABI/testing/sysfs-driver-intel-xe-hwmon:35 > > > Documentation/ABI/testing/sysfs-driver-intel-i915-hwmon:52 > > > Warning: /sys/devices/.../hwmon/hwmon/energy1_input is defined 2 > > > times: Documentation/ABI/testing/sysfs-driver-intel-xe-hwmon:54 > > > Documentation/ABI/testing/sysfs-driver-intel-i915-hwmon:65 > > > Warning: /sys/devices/.../hwmon/hwmon/in0_input is defined 2 times: > > > Documentation/ABI/testing/sysfs-driver-intel-xe-hwmon:46 > > > Documentation/ABI/testing/sysfs-driver-intel-i915-hwmon:0 > > > Warning: /sys/devices/.../hwmon/hwmon/power1_crit is defined 2 times: > > > Documentation/ABI/testing/sysfs-driver-intel-xe-hwmon:22 > > > Documentation/ABI/testing/sysfs-driver-intel-i915-hwmon:39 > > > Warning: /sys/devices/.../hwmon/hwmon/power1_max is defined 2 times: > > > Documentation/ABI/testing/sysfs-driver-intel-xe-hwmon:0 > > > Documentation/ABI/testing/sysfs-driver-intel-i915-hwmon:8 > > > Warning: /sys/devices/.../hwmon/hwmon/power1_max_interval is defined 2 > > > times: Documentation/ABI/testing/sysfs-driver-intel-xe-hwmon:62 > > > Documentation/ABI/testing/sysfs-driver-intel-i915-hwmon:30 > > > Warning: /sys/devices/.../hwmon/hwmon/power1_rated_max is defined 2 > > > times: Documentation/ABI/testing/sysfs-driver-intel-xe-hwmon:14 > > > Documentation/ABI/testing/sysfs-driver-intel-i915-hwmon:22 > > > > /snip/ > > > > > diff --git a/Documentation/ABI/testing/sysfs-driver-intel-i915-hwmon > > > b/Documentation/ABI/testing/sysfs-driver-intel-i915-hwmon > > > index 8d7d8f05f6cd..92fe7c5c5ac1 100644 > > > --- a/Documentation/ABI/testing/sysfs-driver-intel-i915-hwmon > > > +++ b/Documentation/ABI/testing/sysfs-driver-intel-i915-hwmon > > > @@ -1,4 +1,4 @@ > > > -What:/sys/devices/.../hwmon/hwmon/in0_input > > > > Are the warnings happening because this path doesn't exist? > > > > > +What:/sys/bus/pci/drivers/i915/.../hwmon/hwmon/in0_input > > > > So this I guess could also be > > > > /sys/class/drm/card/device/hwmon/hwmon/in0_input? > > no. the issue is not that it doesn't exist, but that the same path is > documented in 2 different places. If the interface is exactly the same, > there could be just 1 place to document it and then reuse the same file > (without the module name). If the interfaces are not identical, then we > should differentiate them like is done here. > > +i915 maintainers > > Are you ok with merging this through either xe or i915 trees > instead of splitting the patch? My preference is the first option. it won't conflict with anything we have on our side there, so it can go with drm-xe-next. Acked-by: Rodrigo Vivi > > > Reviewed-by: Lucas De Marchi > > also tested that this fixes the issue when building docs. > > thanks > Lucas De Marchi > > > > > But no need to change, what you have is also a valid path. But maybe to > > make clear: > > > > /sys/bus/pci/drivers/i915//hwmon/hwmon/in0_input > > > > ? > > > > But anyway... > > > > Assuming you turned on the htmldoc build option, could reproduce this and > > verified that this patch is fixing these warnings, this is: > > > > Reviewed-by: Ashutosh Dixit
Re: Re: [PATCH v2] drm/hwmon: Fix abi doc warnings
On Mon, 29 Jan 2024, Rodrigo Vivi wrote: > On Mon, Jan 29, 2024 at 09:18:59AM -0600, Lucas De Marchi wrote: >> no. the issue is not that it doesn't exist, but that the same path is >> documented in 2 different places. If the interface is exactly the same, >> there could be just 1 place to document it and then reuse the same file >> (without the module name). If the interfaces are not identical, then we >> should differentiate them like is done here. Completely agreed. >> >> +i915 maintainers >> >> Are you ok with merging this through either xe or i915 trees >> instead of splitting the patch? My preference is the first option. > > it won't conflict with anything we have on our side there, so > it can go with drm-xe-next. > > Acked-by: Rodrigo Vivi Acked-by: Jani Nikula -- Jani Nikula, Intel
Re: Re: Re: [PATCH v2] drm/hwmon: Fix abi doc warnings
On Mon, Jan 29, 2024 at 06:36:13PM +0200, Jani Nikula wrote: On Mon, 29 Jan 2024, Rodrigo Vivi wrote: On Mon, Jan 29, 2024 at 09:18:59AM -0600, Lucas De Marchi wrote: no. the issue is not that it doesn't exist, but that the same path is documented in 2 different places. If the interface is exactly the same, there could be just 1 place to document it and then reuse the same file (without the module name). If the interfaces are not identical, then we should differentiate them like is done here. Completely agreed. +i915 maintainers Are you ok with merging this through either xe or i915 trees instead of splitting the patch? My preference is the first option. it won't conflict with anything we have on our side there, so it can go with drm-xe-next. Acked-by: Rodrigo Vivi Acked-by: Jani Nikula thank you all. Pushed to drm-xe-next. Lucas De Marchi -- Jani Nikula, Intel
