Documentation: dt-bindings,hwmon: Add Aspeed PECI hwmon
PATCH 4/6 Documentation: dt-bindings,hwmon: Add Aspeed PECI hwmon
This commit add dt-bindings and hwmon documents for Aspeed PECI hwmon.
--- .../bindings/hwmon/aspeed-peci-hwmon.txt | 89 ++++++++++++++++++++++ Documentation/hwmon/aspeed-peci-hwmon | 64 ++++++++++++++++ 2 files changed, 153 insertions(+) create mode 100644 Documentation/devicetree/bindings/hwmon/aspeed-peci-hwmon.txt create mode 100644 Documentation/hwmon/aspeed-peci-hwmon
Documentation/devicetree/bindings/hwmon/aspeed-peci-hwmon.txt new file +89 -0
@@ -0,0 +1,89 @@ +* ASPEED PECI (Platform Environment Control Interface) hwmon driver. + +Dependency: +- This driver uses ASPEED PECI kernel misc driver as a controller interface + which can be enabled by setting CONFIG_ASPEED_PECI as yes. + +Required properties: +- multi-functional device body: "aspeed,ast2400-peci" or "aspeed,ast2500-peci" + - aspeed,ast2400-peci: Aspeed AST2400 family PECI MFD + - aspeed,ast2500-peci: Aspeed AST2500 family PECI MFD +- compatible: "aspeed,ast2400-peci-hwmon" or "aspeed,ast2500-peci-hwmon" + - aspeed,ast2400-peci-hwmon: Aspeed AST2400 family PECI hwmon + - aspeed,ast2500-peci-hwmon: Aspeed AST2500 family PECI hwmon +- cpu-id: Should contain CPU socket ID + - 0 ~ 7 + +Optional properties: +- show-core: If this property is 1, core temperature attributes will be + enumerated. + 0 or 1 (default: 1) + In fact, these will be appeared when first reading on other attr + happens because it needs cpu info reading. The number of generated + core attrs depends on the number of cores of the cpu package. +- dimm-nums: Should contain the number of DIMM slots that attached to the CPU + which is indicated by cpu-id. + 0 ~ 16 (default: 16) + In case of 0, DIMM temperature attrs will not be enumerated. + +Example: + peci: peci@1e78b000 { + compatible = "aspeed,ast2500-peci", "simple-mfd"; + + peci_hwmon0: peci-hwmon-cpu0 { + compatible = "aspeed,ast2500-peci-hwmon"; + cpu-id = <0>; + show-core = <1>; + dimm-nums = <16>; + }; + + peci_hwmon1: peci-hwmon-cpu1 { + compatible = "aspeed,ast2500-peci-hwmon"; + cpu-id = <1>; + show-core = <1>; + dimm-nums = <16>; + }; + + peci_hwmon2: peci-hwmon-cpu2 { + compatible = "aspeed,ast2500-peci-hwmon"; + cpu-id = <2>; + show-core = <1>; + dimm-nums = <16>; + }; + + peci_hwmon3: peci-hwmon-cpu3 { + compatible = "aspeed,ast2500-peci-hwmon"; + cpu-id = <3>; + show-core = <1>; + dimm-nums = <16>; + }; + + peci_hwmon4: peci-hwmon-cpu4 { + compatible = "aspeed,ast2500-peci-hwmon"; + cpu-id = <4>; + show-core = <1>; + dimm-nums = <16>; + }; + + peci_hwmon5: peci-hwmon-cpu5 { + compatible = "aspeed,ast2500-peci-hwmon"; + cpu-id = <5>; + show-core = <1>; + dimm-nums = <16>; + }; + + peci_hwmon6: peci-hwmon-cpu6 { + compatible = "aspeed,ast2500-peci-hwmon"; + cpu-id = <6>; + show-core = <1>; + dimm-nums = <16>; + }; + + peci_hwmon7: peci-hwmon-cpu7 { + compatible = "aspeed,ast2500-peci-hwmon"; + cpu-id = <7>; + show-core = <1>; + dimm-nums = <16>; + }; + }; +
Documentation/hwmon/aspeed-peci-hwmon new file +64 -0
64 lines not on this page · raw message
Signature · 1 line
2.15.1
Re: [PATCH 4/6] Documentation: dt-bindings, hwmon: Add Aspeed PECI hwmon
Quoted 4 lines · Jae Hyun Yoo
This commit add dt-bindings and hwmon documents for Aspeed PECI hwmon.
Signed-off-by Jae Hyun Yoo <[email protected]>
Quoted 8 lines
--- .../bindings/hwmon/aspeed-peci-hwmon.txt | 89 ++++++++++++++++++++++ Documentation/hwmon/aspeed-peci-hwmon | 64 ++++++++++++++++ 2 files changed, 153 insertions(+) create mode 100644 Documentation/devicetree/bindings/hwmon/aspeed-peci-hwmon.txt create mode 100644 Documentation/hwmon/aspeed-peci-hwmon
I'd recommend splitting out these changes, it will make upstream a bit happier. I'd recommend sending upstream as soon as possible as well.
Quoted 32 lines
diff --git
a/Documentation/devicetree/bindings/hwmon/aspeed-peci-hwmon.txtb/Documentation/devicetree/bindings/hwmon/aspeed-peci-hwmon.txtnew file mode 100644
index 000000000000..a20a82f3380cDocumentation/devicetree/bindings/hwmon/aspeed-peci-hwmon.txt new file +4
-0@@ -0,0 +1,89 @@ +* ASPEED PECI (Platform Environment Control Interface) hwmon driver. + +Dependency: +- This driver uses ASPEED PECI kernel misc driver as a controllerinterface
Documentation/devicetree/bindings/hwmon/aspeed-peci-hwmon.txt new file +4
-0+ which can be enabled by setting CONFIG_ASPEED_PECI as yes. + +Required properties: +- multi-functional device body: "aspeed,ast2400-peci" or"aspeed,ast2500-peci"
Documentation/devicetree/bindings/hwmon/aspeed-peci-hwmon.txt new file +13
-0+ - aspeed,ast2400-peci: Aspeed AST2400 family PECI MFD + - aspeed,ast2500-peci: Aspeed AST2500 family PECI MFD +- compatible: "aspeed,ast2400-peci-hwmon" or "aspeed,ast2500-peci-hwmon" + - aspeed,ast2400-peci-hwmon: Aspeed AST2400 family PECI hwmon + - aspeed,ast2500-peci-hwmon: Aspeed AST2500 family PECI hwmon +- cpu-id: Should contain CPU socket ID + - 0 ~ 7 + +Optional properties: +- show-core: If this property is 1, core temperature attributes will be + enumerated. + 0 or 1 (default: 1) + In fact, these will be appeared when first reading on other
Quoted 5 lines
attr
+ happens because it needs cpu info reading. The number of
generated
+ core attrs depends on the number of cores of the cpu
package.
A couple of points here:
It seems show-core is actually a boolean property. In this case you don't need to describe a value; you can simple measure the presence or absence of the property in the node rather than assigning the property 0 or 1.
Separately, from the description it sounds like the hwmon attributes will appear "dynamically", i.e. after probe time. If that's not the case then disregard the following, but i expect this will have a tough time upstream. probe() should do the reads and determine the number of attributes required. Whilst I think you're right to document this behaviour, I don't think the bindings documentation is the right place for it
Quoted 56 lines
+- dimm-nums: Should contain the number of DIMM slots that attached to the CPU
Documentation/devicetree/bindings/hwmon/aspeed-peci-hwmon.txt new file +54
-0+ which is indicated by cpu-id. + 0 ~ 16 (default: 16) + In case of 0, DIMM temperature attrs will not be enumerated. + +Example: + peci: peci@1e78b000 { + compatible = "aspeed,ast2500-peci", "simple-mfd"; + + peci_hwmon0: peci-hwmon-cpu0 { + compatible = "aspeed,ast2500-peci-hwmon"; + cpu-id = <0>; + show-core = <1>; + dimm-nums = <16>; + }; + + peci_hwmon1: peci-hwmon-cpu1 { + compatible = "aspeed,ast2500-peci-hwmon"; + cpu-id = <1>; + show-core = <1>; + dimm-nums = <16>; + }; + + peci_hwmon2: peci-hwmon-cpu2 { + compatible = "aspeed,ast2500-peci-hwmon"; + cpu-id = <2>; + show-core = <1>; + dimm-nums = <16>; + }; + + peci_hwmon3: peci-hwmon-cpu3 { + compatible = "aspeed,ast2500-peci-hwmon"; + cpu-id = <3>; + show-core = <1>; + dimm-nums = <16>; + }; + + peci_hwmon4: peci-hwmon-cpu4 { + compatible = "aspeed,ast2500-peci-hwmon"; + cpu-id = <4>; + show-core = <1>; + dimm-nums = <16>; + }; + + peci_hwmon5: peci-hwmon-cpu5 { + compatible = "aspeed,ast2500-peci-hwmon"; + cpu-id = <5>; + show-core = <1>; + dimm-nums = <16>; + }; + + peci_hwmon6: peci-hwmon-cpu6 { + compatible = "aspeed,ast2500-peci-hwmon"; + cpu-id = <6>; + show-core = <1>;
Documentation/devicetree/bindings/hwmon/aspeed-peci-hwmon.txt line 88
Quoted 10 lines
Documentation/devicetree/bindings/hwmon/aspeed-peci-hwmon.txt new file +10
-0+ dimm-nums = <16>; + }; + + peci_hwmon7: peci-hwmon-cpu7 { + compatible = "aspeed,ast2500-peci-hwmon"; + cpu-id = <7>; + show-core = <1>; + dimm-nums = <16>; + }; + };
Example is probably a little verbose. You get the same effect with describing just two sockets.
Quoted 83 lines
Documentation/devicetree/bindings/hwmon/aspeed-peci-hwmon.txt new file +1
-0+Documentation/hwmon/aspeed-peci-hwmon new file +14
-0@@ -0,0 +1,64 @@ +Kernel driver aspeed-peci-hwmon +=============================== + +Supported chips: + ASPEED AST2400/2500 + +Author: + Jae Hyun Yoo <[email protected]> + + +Hardware Interfaces +------------------- + +This driver uses ASPEED PECI kernel misc driver as a controllerinterface which
Documentation/hwmon/aspeed-peci-hwmon new file +13
-0+can be enabled by setting CONFIG_ASPEED_PECI as yes. + + +Description +----------- + +This driver implements support for the ASPEED AST2400/2500 PECI hwmon. + + +sysfs files +----------- + +temp1_input Provides current die temperature of the CPUpackage.
+temp1_max Provides thermal control temperature of the CPU
packageDocumentation/hwmon/aspeed-peci-hwmon new file +2
-0+ which is also known as Tcontrol. +temp1_crit Provides shutdown temperature of the CPU packagewhich
Documentation/hwmon/aspeed-peci-hwmon new file +3
-0+ is also known as the maximum processor junction + temperature, Tjmax or Tprochot. +temp1_crit_hyst Provides the hysteresis value fromTcontrol to Tjmax of
Documentation/hwmon/aspeed-peci-hwmon new file +3
-0+ the CPU package. + +temp2_input Provides current DTS thermal margin to Tcontrolof the
Documentation/hwmon/aspeed-peci-hwmon new file +2
-0+ CPU package. Value 0 means it reaches to Tcontrol + temperature. Sub-zero value means the dietemperature
Documentation/hwmon/aspeed-peci-hwmon new file +2
-0+ goes across Tconrtol to Tjmax. +temp2_min Provides the minimum DTS thermal margin toTcontrol of
Documentation/hwmon/aspeed-peci-hwmon new file +2
-0+ the CPU package. +temp2_lcrit Provides the value when the CPU packagetemperature
Documentation/hwmon/aspeed-peci-hwmon new file +4
-0+ reaches to Tjmax. + +temp3_input Provides current Tcontrol temperature of the CPU + package which is also known as Fan Temperaturetarget.
+ Indicates the relative value from thermal monitor
tripDocumentation/hwmon/aspeed-peci-hwmon new file +2
-0+ temperature at which fans should be engaged. +temp3_crit Provides Tcontrol critical value of the CPUpackage
Documentation/hwmon/aspeed-peci-hwmon new file +4
-0+ which is same to Tjmax. + +temp4_input Provides current Tthrottle temperature of the CPU + package. Used for throttling temperature. If thisvalue
+ is allowed and lower than Tjmax - the throttle
willDocumentation/hwmon/aspeed-peci-hwmon new file +6
-0+ occur and reported at lower than Tjmax. + +temp[100-127]_input Provides current core temperature. +temp[100-127]_max Provides thermal control temperature of the core. +temp[100-127]_crit Provides shutdown temperature of the core. +temp[100-127]_crit_hyst Provides the hysteresis value fromTcontrol to Tjmax of
Documentation/hwmon/aspeed-peci-hwmon line 63
Quoted 3 lines
Documentation/hwmon/aspeed-peci-hwmon new file +3
-0+ the core. + +temp[200-215]_input Provides current temperature of the DDR DIMM.
I think you're going to struggle getting support for the discontinuities in the numbering.
Cheers
Andrew
Quoted 4 lines
+
Signature · 1 line
2.15.1
Quoted 14 lines · Andrew Jeffery
Quoted 4 lines · Jae Hyun Yoo
This commit add dt-bindings and hwmon documents for Aspeed PECI hwmon.
Signed-off-by Jae Hyun Yoo <[email protected]>Quoted 8 lines
--- .../bindings/hwmon/aspeed-peci-hwmon.txt | 89 ++++++++++++++++++++++ Documentation/hwmon/aspeed-peci-hwmon | 64 ++++++++++++++++ 2 files changed, 153 insertions(+)create mode 100644
Documentation/devicetree/bindings/hwmon/aspeed-peci-hwmon.txtcreate mode 100644Documentation/hwmon/aspeed-peci-hwmon
Quoted 3 lines
I'd recommend splitting out these changes, it will make upstream a bit happier. I'd recommend sending upstream as soon as possible as well.
Okay, no problem. I'll split these out. Also, I will add upstream maintainers as well from the v2 patch set.
Quoted 40 lines
Quoted 32 lines
diff --git
a/Documentation/devicetree/bindings/hwmon/aspeed-peci-hwmon.txtb/Documentation/devicetree/bindings/hwmon/aspeed-peci-hwmon.txtnew file mode 100644
index 000000000000..a20a82f3380cDocumentation/devicetree/bindings/hwmon/aspeed-peci-hwmon.txt new file +4
-0@@ -0,0 +1,89 @@ +* ASPEED PECI (Platform Environment Control Interface) hwmon driver. + +Dependency: +- This driver uses ASPEED PECI kernel misc driver as a controllerinterface
Documentation/devicetree/bindings/hwmon/aspeed-peci-hwmon.txt new file +4
-0+ which can be enabled by setting CONFIG_ASPEED_PECI as yes. + +Required properties: +- multi-functional device body: "aspeed,ast2400-peci" or"aspeed,ast2500-peci"
Documentation/devicetree/bindings/hwmon/aspeed-peci-hwmon.txt new file +13
-0+ - aspeed,ast2400-peci: Aspeed AST2400 family PECI MFD + - aspeed,ast2500-peci: Aspeed AST2500 family PECI MFD +- compatible: "aspeed,ast2400-peci-hwmon" or "aspeed,ast2500-peci-hwmon" + - aspeed,ast2400-peci-hwmon: Aspeed AST2400 family PECI hwmon + - aspeed,ast2500-peci-hwmon: Aspeed AST2500 family PECI hwmon +- cpu-id: Should contain CPU socket ID + - 0 ~ 7 + +Optional properties: +- show-core: If this property is 1, core temperature attributes will be + enumerated. + 0 or 1 (default: 1) + In fact, these will be appeared when first reading on otherQuoted 5 lines
attr
+ happens because it needs cpu info reading. The number of
generated
+ core attrs depends on the number of cores of the cpu
package.A couple of points here:
Quoted 5 lines
It seems show-core is actually a boolean property. In this case you don't need to describe a value; you can simple measure the presence or absence of the property in the node rather than assigning the property 0 or 1.
Agreed. Will fix it.
Quoted 8 lines
Separately, from the description it sounds like the hwmon attributes will appear "dynamically", i.e. after probe time. If that's not the case then disregard the following, but i expect this will have a tough time upstream.
probe()should do the reads and determine the number of attributes required. Whilst I think you're right to document this behaviour, I don't think the bindings documentation is the right place for it
You described it correctly. Actually, it tries to create core temperature attributes when probe() is called but in case of CPU offline, it can't create these attributes because it can't retrieve physical core numbers information from the CPU, so the creation will be deferred after the first reading on an another attribute happens when the host CPU is back online. It's kind of a PECI restriction.
I agree with you that the bindings documentation isn't the right place to describe it. Will move it into hwmon documentation.
Quoted 61 lines
Quoted 61 lines
+- dimm-nums: Should contain the number of DIMM slots that attached to the CPU
Documentation/devicetree/bindings/hwmon/aspeed-peci-hwmon.txt new file +59
-0+ which is indicated by cpu-id. + 0 ~ 16 (default: 16) + In case of 0, DIMM temperature attrs will not be enumerated. + +Example: + peci: peci@1e78b000 { + compatible = "aspeed,ast2500-peci", "simple-mfd"; + + peci_hwmon0: peci-hwmon-cpu0 { + compatible = "aspeed,ast2500-peci-hwmon"; + cpu-id = <0>; + show-core = <1>; + dimm-nums = <16>; + }; + + peci_hwmon1: peci-hwmon-cpu1 { + compatible = "aspeed,ast2500-peci-hwmon"; + cpu-id = <1>; + show-core = <1>; + dimm-nums = <16>; + }; + + peci_hwmon2: peci-hwmon-cpu2 { + compatible = "aspeed,ast2500-peci-hwmon"; + cpu-id = <2>; + show-core = <1>; + dimm-nums = <16>; + }; + + peci_hwmon3: peci-hwmon-cpu3 { + compatible = "aspeed,ast2500-peci-hwmon"; + cpu-id = <3>; + show-core = <1>; + dimm-nums = <16>; + }; + + peci_hwmon4: peci-hwmon-cpu4 { + compatible = "aspeed,ast2500-peci-hwmon"; + cpu-id = <4>; + show-core = <1>; + dimm-nums = <16>; + }; + + peci_hwmon5: peci-hwmon-cpu5 { + compatible = "aspeed,ast2500-peci-hwmon"; + cpu-id = <5>; + show-core = <1>; + dimm-nums = <16>; + }; + + peci_hwmon6: peci-hwmon-cpu6 { + compatible = "aspeed,ast2500-peci-hwmon"; + cpu-id = <6>; + show-core = <1>; + dimm-nums = <16>; + }; + + peci_hwmon7: peci-hwmon-cpu7 { + compatible = "aspeed,ast2500-peci-hwmon";
Quoted 9 lines
Documentation/devicetree/bindings/hwmon/aspeed-peci-hwmon.txt line 88
Quoted 5 lines
Documentation/devicetree/bindings/hwmon/aspeed-peci-hwmon.txt new file +5
-0+ cpu-id = <7>; + show-core = <1>; + dimm-nums = <16>; + }; + };Example is probably a little verbose. You get the same effect with describing just two sockets.
Yes it is. I'll fix it like you said.
Quoted 81 lines
Quoted 81 lines
Documentation/devicetree/bindings/hwmon/aspeed-peci-hwmon.txt new file +1
-0+Documentation/hwmon/aspeed-peci-hwmon new file +14
-0@@ -0,0 +1,64 @@ +Kernel driver aspeed-peci-hwmon +=============================== + +Supported chips: + ASPEED AST2400/2500 + +Author: + Jae Hyun Yoo <[email protected]> + + +Hardware Interfaces +------------------- + +This driver uses ASPEED PECI kernel misc driver as a controllerinterface which
Documentation/hwmon/aspeed-peci-hwmon new file +13
-0+can be enabled by setting CONFIG_ASPEED_PECI as yes. + + +Description +----------- + +This driver implements support for the ASPEED AST2400/2500 PECI hwmon. + + +sysfs files +----------- + +temp1_input Provides current die temperature of the CPUpackage.
+temp1_max Provides thermal control temperature of the CPU
packageDocumentation/hwmon/aspeed-peci-hwmon new file +2
-0+ which is also known as Tcontrol. +temp1_crit Provides shutdown temperature of the CPU packagewhich
Documentation/hwmon/aspeed-peci-hwmon new file +3
-0+ is also known as the maximum processor junction + temperature, Tjmax or Tprochot. +temp1_crit_hyst Provides the hysteresis value fromTcontrol to Tjmax of
Documentation/hwmon/aspeed-peci-hwmon new file +3
-0+ the CPU package. + +temp2_input Provides current DTS thermal margin to Tcontrolof the
Documentation/hwmon/aspeed-peci-hwmon new file +2
-0+ CPU package. Value 0 means it reaches to Tcontrol + temperature. Sub-zero value means the dietemperature
Documentation/hwmon/aspeed-peci-hwmon new file +2
-0+ goes across Tconrtol to Tjmax. +temp2_min Provides the minimum DTS thermal margin toTcontrol of
Documentation/hwmon/aspeed-peci-hwmon new file +2
-0+ the CPU package. +temp2_lcrit Provides the value when the CPU packagetemperature
Documentation/hwmon/aspeed-peci-hwmon new file +4
-0+ reaches to Tjmax. + +temp3_input Provides current Tcontrol temperature of the CPU + package which is also known as Fan Temperaturetarget.
+ Indicates the relative value from thermal monitor
tripDocumentation/hwmon/aspeed-peci-hwmon new file +2
-0+ temperature at which fans should be engaged. +temp3_crit Provides Tcontrol critical value of the CPUpackage
Documentation/hwmon/aspeed-peci-hwmon new file +4
-0+ which is same to Tjmax. + +temp4_input Provides current Tthrottle temperature of the CPU + package. Used for throttling temperature. If thisvalue
+ is allowed and lower than Tjmax - the throttle
willDocumentation/hwmon/aspeed-peci-hwmon new file +5
-0+ occur and reported at lower than Tjmax. + +temp[100-127]_input Provides current core temperature. +temp[100-127]_max Provides thermal control temperature of the core. +temp[100-127]_crit Provides shutdown temperature of the core.
Quoted 9 lines
Documentation/hwmon/aspeed-peci-hwmon line 63
Quoted 5 lines
+temp[100-127]_crit_hyst Provides the hysteresis value from
Tcontrol to Tjmax ofDocumentation/hwmon/aspeed-peci-hwmon new file +3
-0+ the core. + +temp[200-215]_input Provides current temperature of the DDR DIMM.I think you're going to struggle getting support for the discontinuities in the numbering.
The current Skylake architecture supports up to 28 physical cores and 16 DIMM slots but it could be changed in the next or later architecture so it is the reason why I put some numbering margin between them. Would it be better to remove these discontinuities in the numbering?
Quoted 4 lines
Cheers
Andrew
Thanks a lot,
Jae
Quoted 4 lines
Quoted 4 lines
+
Signature · 1 line
2.15.1