diff mbox series

[v3,2/2] Add device tree binding documentation for MAX44009

Message ID ab7652d06474f951bf764fdc087035554772d147.1548580142.git.bobbyeshleman@gmail.com (mailing list archive)
State New, archived
Headers show
Series [v3,1/2] Add driver support for MAX44009 light sensor | expand

Commit Message

Bobby Eshleman Jan. 27, 2019, 5:09 p.m. UTC
This patch adds device tree documentation for the max44009 ambient light sensor.

Signed-off-by: Robert Eshleman <bobbyeshleman@gmail.com>
---
Changes to v3:
- None

Changes to v2:
- Clean up style

 .../bindings/iio/light/max44009.txt           | 25 +++++++++++++++++++
 1 file changed, 25 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/iio/light/max44009.txt

Comments

Rob Herring Jan. 30, 2019, 4:54 p.m. UTC | #1
On Sun, Jan 27, 2019 at 09:09:14AM -0800, Robert Eshleman wrote:
> This patch adds device tree documentation for the max44009 ambient light sensor.

Wrap long lines.

Follow the subject style used for the directory (git log --oneline 
<dir>). In this case, 'dt-bindings: iio: light: Add max44009'

> 
> Signed-off-by: Robert Eshleman <bobbyeshleman@gmail.com>
> ---
> Changes to v3:
> - None
> 
> Changes to v2:
> - Clean up style
> 
>  .../bindings/iio/light/max44009.txt           | 25 +++++++++++++++++++
>  1 file changed, 25 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/iio/light/max44009.txt
> 
> diff --git a/Documentation/devicetree/bindings/iio/light/max44009.txt b/Documentation/devicetree/bindings/iio/light/max44009.txt
> new file mode 100644
> index 000000000000..b287d7732e37
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/iio/light/max44009.txt
> @@ -0,0 +1,25 @@
> +* MAX44009 Ambient Light Sensor
> +
> +Required properties:
> +
> +- compatible: should be "maxim,max44009"
> +- reg: the I2C address of the device (default is <0x4a>)
> +
> +Optional properties:
> +
> +- interrupts: interrupt mapping for GPIO IRQ. Should be configured with
> +  IRQ_TYPE_EDGE_FALLING.
> +
> +Refer to interrupt-controller/interrupts.txt for generic interrupt client
> +node bindings.
> +
> +Example:
> +
> +max44009: max44009@4a {

light-sensor@4a

> +	compatible = "maxim,max44009";
> +	reg = <0x4a>;
> +
> +	interrupt-parent = <&gpio1>;
> +	interrupts = <17 IRQ_TYPE_EDGE_FALLING>;
> +};
> +
> -- 
> 2.20.1
>
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/iio/light/max44009.txt b/Documentation/devicetree/bindings/iio/light/max44009.txt
new file mode 100644
index 000000000000..b287d7732e37
--- /dev/null
+++ b/Documentation/devicetree/bindings/iio/light/max44009.txt
@@ -0,0 +1,25 @@ 
+* MAX44009 Ambient Light Sensor
+
+Required properties:
+
+- compatible: should be "maxim,max44009"
+- reg: the I2C address of the device (default is <0x4a>)
+
+Optional properties:
+
+- interrupts: interrupt mapping for GPIO IRQ. Should be configured with
+  IRQ_TYPE_EDGE_FALLING.
+
+Refer to interrupt-controller/interrupts.txt for generic interrupt client
+node bindings.
+
+Example:
+
+max44009: max44009@4a {
+	compatible = "maxim,max44009";
+	reg = <0x4a>;
+
+	interrupt-parent = <&gpio1>;
+	interrupts = <17 IRQ_TYPE_EDGE_FALLING>;
+};
+