Re: [PATCH 4/4] dt-bindings: input: Add documentation for gp2a sensor

From: Dmitry Torokhov
Date: Fri Jan 25 2019 - 20:32:43 EST


On Fri, Jan 25, 2019 at 06:50:45PM +0100, PaweÅ Chmiel wrote:
> From: Jonathan Bakker <xc-racer2@xxxxxxx>
>
> This commit adds documentation for Sharp GP2AP002A00F.
> It's Proximity/Opto Sensor connected over i2c.
>
> Signed-off-by: Jonathan Bakker <xc-racer2@xxxxxxx>
> Signed-off-by: PaweÅ Chmiel <pawel.mikolaj.chmiel@xxxxxxxxx>
> ---
> .../bindings/input/sharp,gp2ap002a00f.txt | 29 +++++++++++++++++++
> 1 file changed, 29 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/input/sharp,gp2ap002a00f.txt
>
> diff --git a/Documentation/devicetree/bindings/input/sharp,gp2ap002a00f.txt b/Documentation/devicetree/bindings/input/sharp,gp2ap002a00f.txt
> new file mode 100644
> index 000000000000..c524eb7d3d60
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/input/sharp,gp2ap002a00f.txt
> @@ -0,0 +1,29 @@
> +* Sharp GP2AP002A00F I2C Proximity/Opto Sensor
> +
> +Required properties:
> +- compatible : Should be "sharp,gp2ap002a00f"
> +- reg : The I2C address of the sensor
> +- vout-gpio : The gpio connected to the vout pin

Do you know what it is for?

> +- interrupt-parent : should be the phandle for the interrupt controller
> +- interrupts : Interrupt mapping for GPIO IRQ, it should by configured with
> + flags IRQ_TYPE_EDGE_BOTH
> +
> +Optional properties:
> +- wakeup : If the device is capable of waking up the system
> +- io-channels : Phandle to an ADC channel connected to the light sensor
> +- io-channel-names = "light";
> +- poll-interval : Poll interval time in milliseconds, default 500ms
> +- light-adc-max : Maximum light value reported, default 4096
> +- light-adc-fuzz : Fuzz value for reported light value, default 80
> +
> +Example:
> +
> +gp2a@44 {
> + compatible = "sharp,gp2ap002a00f";
> + reg = <0x44>;
> + vout-gpio = <&gph0 2 GPIO_ACTIVE_HIGH>;
> + interrupt-parent = <&gph0>;
> + interrupts = <2 IRQ_TYPE_EDGE_BOTH>;
> + io-channels = <&adc 9>;
> + io-channel-names = "light";
> +};
> --
> 2.17.1
>

--
Dmitry