diff mbox

[1/4] thermal: rcar_gen3_thermal: Document the R-Car Gen3 thermal bindings

Message ID 57661290.9000501@rvc.renesas.com (mailing list archive)
State Changes Requested
Delegated to: Zhang Rui
Headers show

Commit Message

khiemnguyen June 19, 2016, 3:33 a.m. UTC
Signed-off-by: Hien Dang <hien.dang.eb@rvc.renesas.com>
Signed-off-by: Khiem Nguyen <khiem.nguyen.xt@rvc.renesas.com>
---
 .../bindings/thermal/rcar-gen3-thermal.txt         | 79 ++++++++++++++++++++++
 1 file changed, 79 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/thermal/rcar-gen3-thermal.txt

Comments

Geert Uytterhoeven June 20, 2016, 7:49 a.m. UTC | #1
Hi Khiem,

On Sun, Jun 19, 2016 at 5:33 AM, Khiem Nguyen
<khiem.nguyen.xt@rvc.renesas.com> wrote:
>
> Signed-off-by: Hien Dang <hien.dang.eb@rvc.renesas.com>
> Signed-off-by: Khiem Nguyen <khiem.nguyen.xt@rvc.renesas.com>

Thanks for your patch!

> ---
>  .../bindings/thermal/rcar-gen3-thermal.txt         | 79 ++++++++++++++++++++++
>  1 file changed, 79 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/thermal/rcar-gen3-thermal.txt
>
> diff --git a/Documentation/devicetree/bindings/thermal/rcar-gen3-thermal.txt b/Documentation/devicetree/bindings/thermal/rcar-gen3-thermal.txt
> new file mode 100644
> index 0000000..ed6ce45
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/thermal/rcar-gen3-thermal.txt
> @@ -0,0 +1,79 @@
> +* DT bindings for Renesas R-Car Gen3 Thermal Sensor driver
> +
> +Required properties:
> +- compatible           : "renesas,thermal-<soctype>",

Please use "renesas,<soctype>-thermal", as this is the preferred order for
new bindings.

> +                         Examples with soctypes are:
> +                           - "renesas,thermal-r8a7795" (R-Car H3)

renesas,r8a7795-thermal

> +                           - "renesas,thermal-r8a7796" (R-Car M3)

renesas,r8a7796-thermal, M3-W

> +                           - "renesas,rcar-gen3-thermal" as fallback
> +- reg                  : Address range of the thermal registers.
> +- clocks               : Must contain a reference to the functional clock.

According to the datasheet, the USB_EXTAL clock is also an input for the
thermal block. Should it be added?

> +- #thermal-sensor-cells : Please see ./thermal.txt
> +
> +Option properties:

Optional

> +
> +- interrupts           : Use interrupt
> +- power-domain         : Must contain a reference to the power domain. This property is
> +                         mandatory if the thermal sensor instance is part of a controllable power
> +                         domain.
> +
> +Example (non interrupt support):

Is there a good reason why you wouldn't want to use interrupts?
If not, please make it mandatory.

> +
> +       tsc1: thermal@e6198000 {
> +               compatible = "renesas,thermal-r8a7795",
> +                       "renesas,rcar-gen3-thermal";
> +               reg = <0 0xe6198000 0 0x5c>;

According to the datasheet, there are more registers beyond this range.
Shouldn't it be "reg = <0 0xe6198000 0 0x68>;"?

Gr{oetje,eeting}s,

                        Geert

--
Geert Uytterhoeven -- There's lots of Linux beyond ia32 -- geert@linux-m68k.org

In personal conversations with technical people, I call myself a hacker. But
when I'm talking to journalists I just say "programmer" or something like that.
                                -- Linus Torvalds
--
To unsubscribe from this list: send the line "unsubscribe linux-pm" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
diff mbox

Patch

diff --git a/Documentation/devicetree/bindings/thermal/rcar-gen3-thermal.txt b/Documentation/devicetree/bindings/thermal/rcar-gen3-thermal.txt
new file mode 100644
index 0000000..ed6ce45
--- /dev/null
+++ b/Documentation/devicetree/bindings/thermal/rcar-gen3-thermal.txt
@@ -0,0 +1,79 @@ 
+* DT bindings for Renesas R-Car Gen3 Thermal Sensor driver
+
+Required properties:
+- compatible		: "renesas,thermal-<soctype>",
+			  Examples with soctypes are:
+			    - "renesas,thermal-r8a7795" (R-Car H3)
+			    - "renesas,thermal-r8a7796" (R-Car M3)
+			    - "renesas,rcar-gen3-thermal" as fallback
+- reg			: Address range of the thermal registers.
+- clocks		: Must contain a reference to the functional clock.
+- #thermal-sensor-cells : Please see ./thermal.txt
+
+Option properties:
+
+- interrupts		: Use interrupt
+- power-domain		: Must contain a reference to the power domain. This property is
+			  mandatory if the thermal sensor instance is part of a controllable power
+			  domain.
+
+Example (non interrupt support):
+
+	tsc1: thermal@e6198000 {
+		compatible = "renesas,thermal-r8a7795",
+			"renesas,rcar-gen3-thermal";
+		reg = <0 0xe6198000 0 0x5c>;
+		clocks = <&cpg CPG_MOD 522>;
+		power-domains = <&sysc R8A7795_PD_ALWAYS_ON>;
+		#thermal-sensor-cells = <0>;
+		status = "okay";
+	};
+
+	thermal-zones {
+		sensor_thermal1: sensor-thermal1 {
+			polling-delay-passive = <250>;
+			polling-delay = <1000>;
+
+			/* sensor ID */
+			thermal-sensors = <&tsc1>;
+
+			trips {
+				sensor1_crit: sensor1-crit {
+					temperature = <90000>;
+					hysteresis = <2000>;
+					type = "critical";
+				};
+			};
+		};
+	};
+
+Example (interrupt support):
+
+	tsc1: thermal@e6198000 {
+		compatible = "renesas,thermal-r8a7795",
+			"renesas,rcar-gen3-thermal";
+		reg = <0 0xe6198000 0 0x5c>;
+		interrupts = <GIC_SPI 67 IRQ_TYPE_LEVEL_HIGH>;
+		clocks = <&cpg CPG_MOD 522>;
+		power-domains = <&sysc R8A7795_PD_ALWAYS_ON>;
+		#thermal-sensor-cells = <0>;
+		status = "okay";
+	};
+
+	thermal-zones {
+		sensor_thermal1: sensor-thermal1 {
+			polling-delay-passive = <250>;
+			polling-delay = <0>;
+
+			/* sensor ID */
+			thermal-sensors = <&tsc1>;
+
+			trips {
+				sensor1_crit: sensor1-crit {
+					temperature = <90000>;
+					hysteresis = <2000>;
+					type = "critical";
+				};
+			};
+		};
+	};