diff mbox

[1/4] dt: bindings: add thermal device driver for bcm2835

Message ID 1463063738-11506-2-git-send-email-kernel@martin.sperl.org (mailing list archive)
State New, archived
Headers show

Commit Message

Martin Sperl May 12, 2016, 2:35 p.m. UTC
From: Martin Sperl <kernel@martin.sperl.org>

Add documentation for bcm2835 SOC thermal sensor.

Signed-off-by: Martin Sperl <kernel@martin.sperl.org>
---
 .../devicetree/bindings/thermal/bcm2835-thermal.txt      | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/thermal/bcm2835-thermal.txt

Comments

Eric Anholt May 12, 2016, 11:03 p.m. UTC | #1
kernel@martin.sperl.org writes:

> From: Martin Sperl <kernel@martin.sperl.org>
>
> Add documentation for bcm2835 SOC thermal sensor.
>
> Signed-off-by: Martin Sperl <kernel@martin.sperl.org>
> ---
>  .../devicetree/bindings/thermal/bcm2835-thermal.txt      | 16 ++++++++++++++++
>  1 file changed, 16 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/thermal/bcm2835-thermal.txt
>
> diff --git a/Documentation/devicetree/bindings/thermal/bcm2835-thermal.txt b/Documentation/devicetree/bindings/thermal/bcm2835-thermal.txt
> new file mode 100644
> index 0000000..607519a
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/thermal/bcm2835-thermal.txt

There's a naming convention for the BCM DT bindings these days where you
basically name it after the compatible string, so this file should be
moved to "brcm,bcm2835-thermal.txt" (yes, even though it's inconsistent
with the rest of the files in the directory).

> @@ -0,0 +1,16 @@
> +Binding for Thermal Sensor driver for BCM2835 SoCs.
> +
> +Required parameters:
> +-------------------
> +
> +compatible : 	should be: "brcm,bcm2835-thermal"

Optional: change to 'should be: "brcm,bcm2835-thermal" or
"brcm,bcm2837-thermal"' (see next review for explanation).

I would also drop the space before the colons on the parameters, but as
long as the filename is changed this patch is:

Acked-by: Eric Anholt <eric@anholt.net>

> +reg :		Address range of the thermal registers.
> +clocks : 	Phandle of the clock used by the thermal sensor.
> +
> +Example:
> +
> +thermal: thermal@0x7e212000 {
> +	compatible = "brcm,bcm2835-thermal";
> +	reg = <0x7e212000 0x8>;
> +	clocks = <&clocks BCM2835_CLOCK_TSENS>;
> +};
> -- 
> 2.1.4
diff mbox

Patch

diff --git a/Documentation/devicetree/bindings/thermal/bcm2835-thermal.txt b/Documentation/devicetree/bindings/thermal/bcm2835-thermal.txt
new file mode 100644
index 0000000..607519a
--- /dev/null
+++ b/Documentation/devicetree/bindings/thermal/bcm2835-thermal.txt
@@ -0,0 +1,16 @@ 
+Binding for Thermal Sensor driver for BCM2835 SoCs.
+
+Required parameters:
+-------------------
+
+compatible : 	should be: "brcm,bcm2835-thermal"
+reg :		Address range of the thermal registers.
+clocks : 	Phandle of the clock used by the thermal sensor.
+
+Example:
+
+thermal: thermal@0x7e212000 {
+	compatible = "brcm,bcm2835-thermal";
+	reg = <0x7e212000 0x8>;
+	clocks = <&clocks BCM2835_CLOCK_TSENS>;
+};