| Message ID | 20250106-apds9160-driver-v4-1-f88d9fc45d84@dimonoff.com (mailing list archive) |
|---|---|
| State | New |
| Headers | show |
| Series | Add support for Avago/Broadcom APDS9160 | expand |
On Mon, Jan 06, 2025 at 05:23:01PM -0500, Mikael Gonella-Bolduc wrote: > Add device tree bindings for APDS9160 > Note: Using alternate email for maintainer > > Signed-off-by: Mikael Gonella-Bolduc <mgonellabolduc@dimonoff.com> > --- > .../bindings/iio/light/brcm,apds9160.yaml | 86 ++++++++++++++++++++++ > 1 file changed, 86 insertions(+) > > diff --git a/Documentation/devicetree/bindings/iio/light/brcm,apds9160.yaml b/Documentation/devicetree/bindings/iio/light/brcm,apds9160.yaml > new file mode 100644 > index 0000000000000000000000000000000000000000..756d46c2edb171da840ee49a7339cb781fe84ad2 > --- /dev/null > +++ b/Documentation/devicetree/bindings/iio/light/brcm,apds9160.yaml > @@ -0,0 +1,86 @@ > +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause) > +%YAML 1.2 > +--- > +$id: http://devicetree.org/schemas/iio/light/brcm,apds9160.yaml# > +$schema: http://devicetree.org/meta-schemas/core.yaml# > + > +title: Broadcom Combined Proximity & Ambient light sensor > + > +maintainers: > + - Mikael Gonella-Bolduc <m.gonella.bolduc@gmail.com> > + > +description: | > + Datasheet: https://docs.broadcom.com/docs/APDS-9160-003-DS > + > +properties: > + compatible: > + enum: > + - brcm,apds9160 > + > + reg: > + maxItems: 1 > + > + interrupts: > + maxItems: 1 > + > + vdd-supply: true > + > + ps-cancellation-duration: These all need a vendor prefix. > + $ref: /schemas/types.yaml#/definitions/uint32 > + description: | Don't need '|' if no formatting to preserve. > + Proximity sensor cancellation pulse duration in half clock cycles. > + This parameter determines a cancellation pulse duration. But maybe this is a paragraph break. If so, blank line between paragraphs. And '>' is more appropriate than '|' in that case. > + The cancellation is applied in the integration phase to cancel out > + unwanted reflected light from very near objects such as tempered glass > + in front of the sensor. > + minimum: 0 That's already the min being unsigned. > + maximum: 63 > + default: 0 > + > + ps-cancellation-current-coarse: > + $ref: /schemas/types.yaml#/definitions/uint32 > + description: | > + Proximity sensor crosstalk cancellation current coarse value. > + This parameter adjust the current in steps of 60 nA up to 240 nA. > + This parameter is used in conjunction with the cancellation duration. > + minimum: 0 > + maximum: 4 > + default: 0 > + > + ps-cancellation-current-fine: > + $ref: /schemas/types.yaml#/definitions/uint32 > + description: | > + Proximity sensor crosstalk cancellation current fine value. > + This parameter adjust the current in steps of 2.4 nA up to 36 nA. > + This parameter is used in conjunction with the cancellation duration. > + minimum: 0 > + maximum: 15 > + default: 0 > + > +required: > + - compatible > + - reg > + - vdd-supply > + > +additionalProperties: false > + > +examples: > + - | > + #include <dt-bindings/interrupt-controller/irq.h> > + > + i2c { > + #address-cells = <1>; > + #size-cells = <0>; > + > + light-sensor@53 { > + compatible = "brcm,apds9160"; > + reg = <0x53>; > + vdd-supply = <&vdd_reg>; > + interrupts = <29 IRQ_TYPE_EDGE_FALLING>; > + interrupt-parent = <&pinctrl>; > + ps-cancellation-duration = <10>; > + ps-cancellation-current-coarse = <2>; > + ps-cancellation-current-fine = <10>; > + }; > + }; > +... > > -- > 2.34.1 >
diff --git a/Documentation/devicetree/bindings/iio/light/brcm,apds9160.yaml b/Documentation/devicetree/bindings/iio/light/brcm,apds9160.yaml new file mode 100644 index 0000000000000000000000000000000000000000..756d46c2edb171da840ee49a7339cb781fe84ad2 --- /dev/null +++ b/Documentation/devicetree/bindings/iio/light/brcm,apds9160.yaml @@ -0,0 +1,86 @@ +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/iio/light/brcm,apds9160.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Broadcom Combined Proximity & Ambient light sensor + +maintainers: + - Mikael Gonella-Bolduc <m.gonella.bolduc@gmail.com> + +description: | + Datasheet: https://docs.broadcom.com/docs/APDS-9160-003-DS + +properties: + compatible: + enum: + - brcm,apds9160 + + reg: + maxItems: 1 + + interrupts: + maxItems: 1 + + vdd-supply: true + + ps-cancellation-duration: + $ref: /schemas/types.yaml#/definitions/uint32 + description: | + Proximity sensor cancellation pulse duration in half clock cycles. + This parameter determines a cancellation pulse duration. + The cancellation is applied in the integration phase to cancel out + unwanted reflected light from very near objects such as tempered glass + in front of the sensor. + minimum: 0 + maximum: 63 + default: 0 + + ps-cancellation-current-coarse: + $ref: /schemas/types.yaml#/definitions/uint32 + description: | + Proximity sensor crosstalk cancellation current coarse value. + This parameter adjust the current in steps of 60 nA up to 240 nA. + This parameter is used in conjunction with the cancellation duration. + minimum: 0 + maximum: 4 + default: 0 + + ps-cancellation-current-fine: + $ref: /schemas/types.yaml#/definitions/uint32 + description: | + Proximity sensor crosstalk cancellation current fine value. + This parameter adjust the current in steps of 2.4 nA up to 36 nA. + This parameter is used in conjunction with the cancellation duration. + minimum: 0 + maximum: 15 + default: 0 + +required: + - compatible + - reg + - vdd-supply + +additionalProperties: false + +examples: + - | + #include <dt-bindings/interrupt-controller/irq.h> + + i2c { + #address-cells = <1>; + #size-cells = <0>; + + light-sensor@53 { + compatible = "brcm,apds9160"; + reg = <0x53>; + vdd-supply = <&vdd_reg>; + interrupts = <29 IRQ_TYPE_EDGE_FALLING>; + interrupt-parent = <&pinctrl>; + ps-cancellation-duration = <10>; + ps-cancellation-current-coarse = <2>; + ps-cancellation-current-fine = <10>; + }; + }; +...