Commit 6032afbd authored by Jonathan Cameron's avatar Jonathan Cameron
Browse files

dt-bindings:iio:light:upisemi,us51882: txt to yaml conversion. 



I don't have an up to date address for Adriana Reus so I've put myself
as the binding maintainer for this one.  I'm happy to hand over to Adriana
or anyone else who wants take it on!

This has a lot of optional tuning parameters. The docs are modified to try
and put the default values in the description of each one rather than a
forwards reference to the example.

Signed-off-by: default avatarJonathan Cameron <Jonathan.Cameron@huawei.com>
Reviewed-by: default avatarRob Herring <robh@kernel.org>
Link: https://lore.kernel.org/r/20201031184854.745828-20-jic23@kernel.org
parent 23205227

Documentation/devicetree/bindings/iio/light/upisemi,us5182.yaml

0 → 100644
+78 −0
Original line number Original line Diff line number Diff line 
# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)

%YAML 1.2

---

$id: http://devicetree.org/schemas/iio/light/upisemi,us5182.yaml#

$schema: http://devicetree.org/meta-schemas/core.yaml#



title: UPISEMI us5182d I2C ALS and Proximity sensor



maintainers:

  - Jonathan Cameron <jic23@kernel.org>



properties:

  compatible:

    const: upisemi,asd5182



  reg:

    maxItems: 1



  upsemi,glass-coef:

    $ref: /schemas/types.yaml#/definitions/uint32

    description: |

      glass attenuation factor - compensation factor of resolution 1000

      for material transmittance.

    default: 1000



  upisemi,dark-ths:

    $ref: /schemas/types.yaml#/definitions/uint16-array

    minItems: 8

    maxItems: 8

    description:

      16-bit thresholds (adc counts) corresponding to every scale.



  upisemi,upper-dark-gain:

    $ref: /schemas/types.yaml#/definitions/uint8

    description: |

      8-bit dark gain compensation factor(4 int and 4 fractional bits - Q4.4)

      applied when light > threshold.

    default: 0



  upisemi,lower-dark-gain:

    $ref: /schemas/types.yaml#/definitions/uint8

    description: |

      8-bit dark gain compensation factor(4 int and 4 fractional bits - Q4.4)

      applied when light < threshold.

    default: 0x16



  upisemi,continuous:

    $ref: /schemas/types.yaml#definitions/flag

    description: |

      This chip has two power modes: one-shot (chip takes one measurement and

      then shuts itself down) and continuous (chip takes continuous

      measurements). The one-shot mode is more power-friendly but the

      continuous mode may be more reliable. If this property is specified

      the continuous mode will be used instead of the default one-shot one for

      raw reads.



additionalProperties: false



required:

  - compatible

  - reg



examples:

  - |

    i2c {

        #address-cells = <1>;

        #size-cells = <0>;



        light-sensor@39 {

            compatible = "upisemi,usd5182";

            reg = <0x39>;

            upisemi,glass-coef = < 1000 >;

            upisemi,dark-ths = /bits/ 16 <170 200 512 512 800 2000 4000 8000>;

            upisemi,upper-dark-gain = /bits/ 8 <0x00>;

            upisemi,lower-dark-gain = /bits/ 8 <0x16>;

        };

    };

...

Documentation/devicetree/bindings/iio/light/us5182d.txt

deleted100644 → 0
+0 −45
Original line number Original line Diff line number Diff line 
* UPISEMI us5182d I2C ALS and Proximity sensor



Required properties:

- compatible: must be "upisemi,usd5182"

- reg: the I2C address of the device



Optional properties:

- upisemi,glass-coef: glass attenuation factor - compensation factor of

                      resolution 1000 for material transmittance.



- upisemi,dark-ths: array of 8 elements containing 16-bit thresholds (adc

                    counts) corresponding to every scale.



- upisemi,upper-dark-gain: 8-bit dark gain compensation factor(4 int and 4

                           fractional bits - Q4.4) applied when light > threshold



- upisemi,lower-dark-gain: 8-bit dark gain compensation factor(4 int and 4

                           fractional bits - Q4.4) applied when light < threshold



- upisemi,continuous: This chip has two power modes: one-shot (chip takes one

                      measurement and then shuts itself down) and continuous (

                      chip takes continuous measurements). The one-shot mode is

                      more power-friendly but the continuous mode may be more

                      reliable. If this property is specified the continuous

                      mode will be used instead of the default one-shot one for

                      raw reads.



If the optional properties are not specified these factors will default to the

values in the below example.

The glass-coef defaults to no compensation for the covering material.

The threshold array defaults to experimental values that work with US5182D

sensor on evaluation board - roughly between 12-32 lux.

There will be no dark-gain compensation by default when ALS > thresh

(0 * dark-gain), and a 1.35 compensation factor when ALS < thresh.



Example:



    usd5182@39 {

                compatible = "upisemi,usd5182";

                reg = <0x39>;

                upisemi,glass-coef = < 1000 >;

                upisemi,dark-ths = /bits/ 16 <170 200 512 512 800 2000 4000 8000>;

                upisemi,upper-dark-gain = /bits/ 8 <0x00>;

                upisemi,lower-dark-gain = /bits/ 8 <0x16>;

    };