[PATCH/RFC v5 1/2] DT: Add documentation for gp2ap020a00f sensor

[PATCH/RFC v5 1/2] DT: Add documentation for gp2ap020a00f sensor

[Jacek Anaszewski]

This patch adds device tree binding documentation
for the gp2ap020a00f proximity/als sensor.

Signed-off-by: Jacek Anaszewski <j.anaszewski@samsung.com>
Signed-off-by: Kyungmin Park <kyungmin.park@samsung.com>
---
 .../devicetree/bindings/iio/light/gp2ap020a00f.txt |   17 +++++++++++++++++
 1 files changed, 17 insertions(+), 0 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/iio/light/gp2ap020a00f.txt

diff --git a/Documentation/devicetree/bindings/iio/light/gp2ap020a00f.txt b/Documentation/devicetree/bindings/iio/light/gp2ap020a00f.txt
new file mode 100644
index 0000000..a92fccd
--- /dev/null
+++ b/Documentation/devicetree/bindings/iio/light/gp2ap020a00f.txt
@@ -0,0 +1,17 @@
+* Sharp GP2AP020A00F I2C Proximity/ALS sensor
+
+Required properties:
+
+  - compatible : should be "sharp,gp2ap020a00f"
+  - reg : the I2C slave address of the light sensor
+  - interrupts : should be interrupt line number the INT pin is routed to
+  - vled-supply : VLED power supply, as covered in ../regulator/regulator.txt
+
+Example:
+
+gp2ap020a00f@39 {
+	compatible = "sharp,gp2ap020a00f";
+	reg = <0x39>;
+	interrupts = <2 0>;
+	vled-supply = <...>;
+};
-- 
1.7.5.4

Re: [PATCH/RFC v5 1/2] DT: Add documentation for gp2ap020a00f sensor

[Mark Rutland]

On Tue, Aug 20, 2013 at 03:47:13PM +0100, Jacek Anaszewski wrote:
> This patch adds device tree binding documentation
> for the gp2ap020a00f proximity/als sensor.
> 
> Signed-off-by: Jacek Anaszewski <j.anaszewski@samsung.com>
> Signed-off-by: Kyungmin Park <kyungmin.park@samsung.com>
> ---
>  .../devicetree/bindings/iio/light/gp2ap020a00f.txt |   17 +++++++++++++++++
>  1 files changed, 17 insertions(+), 0 deletions(-)
>  create mode 100644 Documentation/devicetree/bindings/iio/light/gp2ap020a00f.txt
> 
> diff --git a/Documentation/devicetree/bindings/iio/light/gp2ap020a00f.txt b/Documentation/devicetree/bindings/iio/light/gp2ap020a00f.txt
> new file mode 100644
> index 0000000..a92fccd
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/iio/light/gp2ap020a00f.txt
> @@ -0,0 +1,17 @@
> +* Sharp GP2AP020A00F I2C Proximity/ALS sensor
> +
> +Required properties:
> +
> +  - compatible : should be "sharp,gp2ap020a00f"
> +  - reg : the I2C slave address of the light sensor
> +  - interrupts : should be interrupt line number the INT pin is routed to

Nit: DT talks in terms of "interrupt specifiers", which are
interrupt-controller specific descriptions of interrupts. This could be
reworded as:

 - interrupts : an interrupt specifier for the sole interrupt generated
                by the device

> +  - vled-supply : VLED power supply, as covered in ../regulator/regulator.txt

You don't seem to have mentioned this is part of the unit, as discussed
last time [1]. As not all light sensors have embedded LEDs, for clarity
it would be worth mentioning that this is part of the unit.

Thanks,
Mark.

[1] http://marc.info/?l=linux-iio&m=137707379614385&w=2