diff mbox series

[linux,hwmon-next,v3,3/3] dt-bindings: (hwmon/sbtsi_tmep) Add SB-TSI hwmon driver bindings

Message ID 20200405030118.191950-4-kunyi@google.com
State Not Applicable, archived
Headers show
Series SB-TSI hwmon driver v3 | expand

Commit Message

Kun Yi April 5, 2020, 3:01 a.m. UTC
Document device tree bindings for AMD SB-TSI emulated temperature
sensor.

Signed-off-by: Kun Yi <kunyi@google.com>
---
 .../devicetree/bindings/hwmon/amd,sbtsi.txt   | 26 +++++++++++++++++++
 1 file changed, 26 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/hwmon/amd,sbtsi.txt

Comments

Guenter Roeck April 5, 2020, 3:48 p.m. UTC | #1
On 4/4/20 8:01 PM, Kun Yi wrote:
> Document device tree bindings for AMD SB-TSI emulated temperature
> sensor.
> 
> Signed-off-by: Kun Yi <kunyi@google.com>
> ---
>  .../devicetree/bindings/hwmon/amd,sbtsi.txt   | 26 +++++++++++++++++++
>  1 file changed, 26 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/hwmon/amd,sbtsi.txt
> 
> diff --git a/Documentation/devicetree/bindings/hwmon/amd,sbtsi.txt b/Documentation/devicetree/bindings/hwmon/amd,sbtsi.txt
> new file mode 100644
> index 000000000000..be7293c43c0e
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/hwmon/amd,sbtsi.txt
> @@ -0,0 +1,26 @@
> +* Sideband interface Temperature Sensor Interface (SB-TSI) compliant
> +AMD SoC temperature device.
> +
> +SB Temperature Sensor Interface (SB-TSI) is an SMBus compatible
> +interface that reports AMD SoC's Ttcl (normalized temperature),
> +and resembles a typical 8-pin remote temperature sensor's I2C interface
> +to BMC. The emulated thermal sensor can report temperatures in increments of
> +0.125 degrees, ranging from 0 to 255.875.
> +
> +Required properties:
> +- compatible: manufacturer and chip name, should be
> +	"amd,sbtsi",
> +
> +- reg: I2C bus address of the device as specified in Section 6.3.1 of the
> +SoC register reference: The SB-TSI address is normally 98h for socket 0 and
> +90h for socket 1, but it could vary based on hardware address select pins.
> +
> +[open source SoC register reference]:
> +	https://www.amd.com/system/files/TechDocs/56255_OSRR.pdf
> +
> +Example:
> +
> +sbtsi@4c {
> +	compatible = "amd,sbtsi";
> +	reg = <0x4c>;
> +};
> 

Rob is going to ask you to provide this information in DT schema format
(Documentation/devicetree/writing-schema.rst). checkpatch tells you the same
nowadays.

Guenter
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/hwmon/amd,sbtsi.txt b/Documentation/devicetree/bindings/hwmon/amd,sbtsi.txt
new file mode 100644
index 000000000000..be7293c43c0e
--- /dev/null
+++ b/Documentation/devicetree/bindings/hwmon/amd,sbtsi.txt
@@ -0,0 +1,26 @@ 
+* Sideband interface Temperature Sensor Interface (SB-TSI) compliant
+AMD SoC temperature device.
+
+SB Temperature Sensor Interface (SB-TSI) is an SMBus compatible
+interface that reports AMD SoC's Ttcl (normalized temperature),
+and resembles a typical 8-pin remote temperature sensor's I2C interface
+to BMC. The emulated thermal sensor can report temperatures in increments of
+0.125 degrees, ranging from 0 to 255.875.
+
+Required properties:
+- compatible: manufacturer and chip name, should be
+	"amd,sbtsi",
+
+- reg: I2C bus address of the device as specified in Section 6.3.1 of the
+SoC register reference: The SB-TSI address is normally 98h for socket 0 and
+90h for socket 1, but it could vary based on hardware address select pins.
+
+[open source SoC register reference]:
+	https://www.amd.com/system/files/TechDocs/56255_OSRR.pdf
+
+Example:
+
+sbtsi@4c {
+	compatible = "amd,sbtsi";
+	reg = <0x4c>;
+};