[PATCH] k10temp: update documentation

[PATCH] k10temp: update documentation

[Lukas Zapletal]

It's been a while since the k10temp documentation has been updated.
There are new CPU families supported as well as Tdie temp was added.
This patch adds all missing families which I was able to find from git
history and provides more info about Tctl vs Tdie exported temps.

Signed-off-by: Lukas Zapletal <lzap+git@redhat.com>
---
 Documentation/hwmon/k10temp.rst | 19 +++++++++++++++++--
 1 file changed, 17 insertions(+), 2 deletions(-)

diff --git a/Documentation/hwmon/k10temp.rst b/Documentation/hwmon/k10temp.rst
index 12a86ba17de9..bb2d0a02dc45 100644
--- a/Documentation/hwmon/k10temp.rst
+++ b/Documentation/hwmon/k10temp.rst
@@ -1,7 +1,7 @@
 Kernel driver k10temp
 =====================

-Supported chips:
+Although the driver is named k10temp, it supports wide range of AMD CPUs:

 * AMD Family 10h processors:

@@ -21,10 +21,16 @@ Supported chips:

 * AMD Family 14h processors: "Brazos" (C/E/G/Z-Series)

-* AMD Family 15h processors: "Bulldozer" (FX-Series), "Trinity",
"Kaveri", "Carrizo"
+* AMD Family 15h processors: "Bulldozer" (FX-Series), "Trinity",
"Kaveri", "Carrizo", "Stoney Ridge", "Bristol Ridge"

 * AMD Family 16h processors: "Kabini", "Mullins"

+* AMD Family 17h processors: "Zen", "Zen 2"
+
+* AMD Family 18h processors: "Hygon Dhyana"
+
+* AMD Family 19h processors: "Zen 3"
+
   Prefix: 'k10temp'

   Addresses scanned: PCI space
@@ -110,3 +116,12 @@ The maximum value for Tctl is available in the
file temp1_max.
 If the BIOS has enabled hardware temperature control, the threshold at
 which the processor will throttle itself to avoid damage is available in
 temp1_crit and temp1_crit_hyst.
+
+On some AMD CPUs, there is a difference between the die temperature (Tdie) and
+the reported temperature (Tctl). Tdie is the real measured temperature, and
+Tctl is used for fan control. While Tctl is always available as temp1_input,
+the driver exports Tdie temperature as temp2_input for those CPUs which support
+it.
+
+Models from 17h family report relative temperature, the driver aims to
+compensate and report the real temperature.
-- 
2.21.0


-- 
Later,
  Lukas @lzap Zapletal

Re: [PATCH] k10temp: update documentation

[Guenter Roeck]

On Thu, Sep 19, 2019 at 11:25:03AM +0200, Lukas Zapletal wrote:
> It's been a while since the k10temp documentation has been updated.
> There are new CPU families supported as well as Tdie temp was added.
> This patch adds all missing families which I was able to find from git
> history and provides more info about Tctl vs Tdie exported temps.
> 
> Signed-off-by: Lukas Zapletal <lzap+git@redhat.com>

Your patch does not apply to the curent mainline kernel.
What is the parent branch ?

> ---
>  Documentation/hwmon/k10temp.rst | 19 +++++++++++++++++--
>  1 file changed, 17 insertions(+), 2 deletions(-)
> 
> 
>    Addresses scanned: PCI space
> @@ -110,3 +116,12 @@ The maximum value for Tctl is available in the
> file temp1_max.
>  If the BIOS has enabled hardware temperature control, the threshold at
>  which the processor will throttle itself to avoid damage is available in
>  temp1_crit and temp1_crit_hyst.
> +
> +On some AMD CPUs, there is a difference between the die temperature (Tdie) and
> +the reported temperature (Tctl). Tdie is the real measured temperature, and
> +Tctl is used for fan control. While Tctl is always available as temp1_input,
> +the driver exports Tdie temperature as temp2_input for those CPUs which support
> +it.
> +
> +Models from 17h family report relative temperature, the driver aims to
> +compensate and report the real temperature.
> 
> diff --git a/Documentation/hwmon/k10temp.rst b/Documentation/hwmon/k10temp.rst
> index 12a86ba17de9..bb2d0a02dc45 100644
> --- a/Documentation/hwmon/k10temp.rst
> +++ b/Documentation/hwmon/k10temp.rst
> @@ -1,7 +1,7 @@
>  Kernel driver k10temp
>  =====================
> 
> -Supported chips:
> +Although the driver is named k10temp, it supports wide range of AMD CPUs:

The above does not add any value. Many drivers support more than one chip,
but are named after the first supported chip. Please drop this change.

Guenter

> 
>  * AMD Family 10h processors:
> 
> @@ -21,10 +21,16 @@ Supported chips:
> 
>  * AMD Family 14h processors: "Brazos" (C/E/G/Z-Series)
> 
> -* AMD Family 15h processors: "Bulldozer" (FX-Series), "Trinity",
> "Kaveri", "Carrizo"
> +* AMD Family 15h processors: "Bulldozer" (FX-Series), "Trinity",
> "Kaveri", "Carrizo", "Stoney Ridge", "Bristol Ridge"
> 
>  * AMD Family 16h processors: "Kabini", "Mullins"
> 
> +* AMD Family 17h processors: "Zen", "Zen 2"
> +
> +* AMD Family 18h processors: "Hygon Dhyana"
> +
> +* AMD Family 19h processors: "Zen 3"
> +
>    Prefix: 'k10temp'

Re: [PATCH] k10temp: update documentation

[Lukas Zapletal]

> Your patch does not apply to the curent mainline kernel.
> What is the parent branch ?

Oh well, this is my first contribution. I used Greg's staging tree
which I found in a first contributor tutorial on web. I will rebase,
let me know which branch do I need to pick. Thanks.

-- 
Later,
  Lukas @lzap Zapletal

Re: [PATCH] k10temp: update documentation

[Guenter Roeck]

On Sun, Sep 22, 2019 at 08:25:40PM +0200, Lukas Zapletal wrote:
> > Your patch does not apply to the curent mainline kernel.
> > What is the parent branch ?
> 
> Oh well, this is my first contribution. I used Greg's staging tree
> which I found in a first contributor tutorial on web. I will rebase,
> let me know which branch do I need to pick. Thanks.

Mainline should be fine.

Guenter

Re: [PATCH] k10temp: update documentation

[Lukas Zapletal]

I just reposted the patch to hwmon and doc lists. My MUA have put some
trash characters in it, apologies for that.

-- 
Later,
  Lukas @lzap Zapletal

Re: [PATCH] k10temp: update documentation

[Guenter Roeck]

On Mon, Sep 23, 2019 at 09:10:52AM +0200, Lukas Zapletal wrote:
> It's been a while since the k10temp documentation has been updated.
> There are new CPU families supported as well as Tdie temp was added.
> This patch adds all missing families which I was able to find from git
> history and provides more info about Tctl vs Tdie exported temps.
> 
> Signed-off-by: Lukas Zapletal <lzap+git@redhat.com>
> ---
>  Documentation/hwmon/k10temp.rst | 19 +++++++++++++++++--
>  1 file changed, 17 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/hwmon/k10temp.rst b/Documentation/hwmon/k10temp.rst
> index 12a86ba17de9..bb2d0a02dc45 100644
> --- a/Documentation/hwmon/k10temp.rst
> +++ b/Documentation/hwmon/k10temp.rst
> @@ -1,7 +1,7 @@
>  Kernel driver k10temp
>  =====================
>  
> -Supported chips:
> +Although the driver is named k10temp, it supports wide range of AMD CPUs:
>  
I did ask to drop the above, and I won't accept the patch as-is.
Many hwmon (and other) drivers are named after one chip but support
many, it would be quite pointless to state that in each driver's
documentation, and I won't get it started.

Guenter

[PATCH] k10temp: update documentation

[Lukas Zapletal]

It's been a while since the k10temp documentation has been updated.
There are new CPU families supported as well as Tdie temp was added.
This patch adds all missing families which I was able to find from git
history and provides more info about Tctl vs Tdie exported temps.

Signed-off-by: Lukas Zapletal <lzap+git@redhat.com>
---
 Documentation/hwmon/k10temp.rst | 19 +++++++++++++++++--
 1 file changed, 17 insertions(+), 2 deletions(-)

diff --git a/Documentation/hwmon/k10temp.rst b/Documentation/hwmon/k10temp.rst
index 12a86ba17de9..bb2d0a02dc45 100644
--- a/Documentation/hwmon/k10temp.rst
+++ b/Documentation/hwmon/k10temp.rst
@@ -1,7 +1,7 @@
 Kernel driver k10temp
 =====================
 
-Supported chips:
+Although the driver is named k10temp, it supports wide range of AMD CPUs:
 
 * AMD Family 10h processors:
 
@@ -21,10 +21,16 @@ Supported chips:
 
 * AMD Family 14h processors: "Brazos" (C/E/G/Z-Series)
 
-* AMD Family 15h processors: "Bulldozer" (FX-Series), "Trinity", "Kaveri", "Carrizo"
+* AMD Family 15h processors: "Bulldozer" (FX-Series), "Trinity", "Kaveri", "Carrizo", "Stoney Ridge", "Bristol Ridge"
 
 * AMD Family 16h processors: "Kabini", "Mullins"
 
+* AMD Family 17h processors: "Zen", "Zen 2"
+
+* AMD Family 18h processors: "Hygon Dhyana"
+
+* AMD Family 19h processors: "Zen 3"
+
   Prefix: 'k10temp'
 
   Addresses scanned: PCI space
@@ -110,3 +116,12 @@ The maximum value for Tctl is available in the file temp1_max.
 If the BIOS has enabled hardware temperature control, the threshold at
 which the processor will throttle itself to avoid damage is available in
 temp1_crit and temp1_crit_hyst.
+
+On some AMD CPUs, there is a difference between the die temperature (Tdie) and
+the reported temperature (Tctl). Tdie is the real measured temperature, and
+Tctl is used for fan control. While Tctl is always available as temp1_input,
+the driver exports Tdie temperature as temp2_input for those CPUs which support
+it.
+
+Models from 17h family report relative temperature, the driver aims to
+compensate and report the real temperature.
-- 
2.21.0