| Message ID | 20211117084631.2820014-5-gwendal@chromium.org (mailing list archive) |
|---|---|
| State | Superseded |
| Headers | show |
| Series | Expand Semtech SAR Sensors support | expand |
Quoting Gwendal Grignou (2021-11-17 00:46:30) > diff --git a/Documentation/devicetree/bindings/iio/proximity/semtech,sx9324.yaml b/Documentation/devicetree/bindings/iio/proximity/semtech,sx9324.yaml > new file mode 100644 > index 00000000000000..5e2e684400e35a > --- /dev/null > +++ b/Documentation/devicetree/bindings/iio/proximity/semtech,sx9324.yaml > @@ -0,0 +1,136 @@ > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) > +%YAML 1.2 > +--- > +$id: http://devicetree.org/schemas/iio/proximity/semtech,sx9310.yaml# Should be sx9324.yaml > +$schema: http://devicetree.org/meta-schemas/core.yaml# > + > +title: Semtech's SX9324 capacitive proximity sensor > + > +maintainers: > + - Gwendal Grignou <gwendal@chromium.org> > + - Daniel Campello <campello@chromium.org> > + > +description: | > + Semtech's SX9324 proximity sensor. > + > +properties: > + compatible: > + enum: > + - semtech,sx9324 If there's only one compatible then it can be compatible: const: semtech,sx9324 > + > + reg: > + maxItems: 1 > + > + interrupts: > + description: > + Generated by device to announce preceding read request has finished > + and data is available or that a close/far proximity event has happened. > + maxItems: 1 > + > + vdd-supply: > + description: Main power supply > + > + svdd-supply: > + description: Host interface power supply > + > + "#io-channel-cells": > + const: 1 > + > + semtech,ph0-pin: > + $ref: /schemas/types.yaml#/definitions/uint32-array > + description: | > + Indicates how each CS pin is used during phase 0. > + Each of the 3 pins have the following value - Can you also indicate that the index of the array corresponds to each channel? > + 0 : unused (high impedance) > + 1 : measured input > + 2 : dynamic shield > + 3 : grounded. > + For instance, CS0 measured, CS1 shield and CS2 ground is [1, 2, 3] > + items: > + enum: [ 0, 1, 2, 3 ] > + minItems: 3 > + maxItems: 3 > + > + semtech,ph1-pin: > + semtech,ph2-pin: > + semtech,ph3-pin: > + Same as ph0-pin I'm fairly certain we need to duplicate the ph0-pin description each time. And presumably ph1 is for phase 1? > + > + semtech,resolution01 > + $ref: /schemas/types.yaml#definitions/uint32 > + enum: [8, 16, 32, 64, 128, 256, 512, 1024] > + description: > + Capacitance measurement resolution. For phase 0 and 1. > + Higher the number, higher the resolution. > + default: 128 > + > + semtech,resolution23 > + $ref: /schemas/types.yaml#definitions/uint32 > + enum: [8, 16, 32, 64, 128, 256, 512, 1024] > + description: > + Capacitance measurement resolution. For phase 2 and 3 > + default: 128 Can this be a single combined u32 array for each phase? > + > + semtech,startup-sensor: > + $ref: /schemas/types.yaml#definitions/uint32 > + enum: [0, 1, 2, 3] > + default: 0 > + description: > + Phase used for start-up proximity detection. > + It is used when we enable a phase to remove static offset and measure > + only capacitance changes introduced by the user. > + > + semtech,proxraw-strength01: > + $ref: /schemas/types.yaml#definitions/uint32 > + min: 0 > + max: 7 > + default: 1 > + description: > + PROXRAW filter strength for phase 0 and 1. A value of 0 represents off, > + and other values represent 1-1/2^N. > + > + semtech,proxraw-strength23: > + Same as proxraw-strength01, for phase 2 and 3. Likewise, can this be combined into one array for all phases? > + > + semtech,avg-pos-strength: > + $ref: /schemas/types.yaml#definitions/uint32 > + enum: [0, 16, 64, 128, 256, 512, 1024, 4294967295] > + default: 16 > + description: > + Average positive filter strength. A value of 0 represents off and > + UINT_MAX (4294967295) represents infinite. Other values > + represent 1-1/N. > + > +required: > + - compatible > + - reg > + - "#io-channel-cells" > + > +additionalProperties: false > + > +examples: > + - | > + #include <dt-bindings/interrupt-controller/irq.h> > + i2c { > + #address-cells = <1>; > + #size-cells = <0>; > + proximity@28 { > + compatible = "semtech,sx9310"; Should be semtech,sx9324 > + reg = <0x28>; > + interrupt-parent = <&pio>; > + interrupts = <5 IRQ_TYPE_LEVEL_LOW 5>; > + vdd-supply = <&pp3300_a>; > + svdd-supply = <&pp1800_prox>; > + #io-channel-cells = <1>; > + semtech,ph0-pin = <1, 2, 3>; > + semtech,ph1-pin = <3, 2, 1>; > + semtech,ph2-pin = <1, 2, 3>; > + semtech,ph3-pin = <3, 2, 1>; > + semtech,resolution01 = 2; > + semtech,resolution23 = 2; > + semtech,startup-sensor = <1>; > + semtech,proxraw-strength01 = <2>; > + semtech,proxraw-strength23 = <2>; > + semtech,avg-pos-strength = <64>; > + }; > + };
On Wed, Nov 17, 2021 at 10:55 PM Stephen Boyd <swboyd@chromium.org> wrote: > > Quoting Gwendal Grignou (2021-11-17 00:46:30) > > diff --git a/Documentation/devicetree/bindings/iio/proximity/semtech,sx9324.yaml b/Documentation/devicetree/bindings/iio/proximity/semtech,sx9324.yaml > > new file mode 100644 > > index 00000000000000..5e2e684400e35a > > --- /dev/null > > +++ b/Documentation/devicetree/bindings/iio/proximity/semtech,sx9324.yaml > > @@ -0,0 +1,136 @@ > > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) > > +%YAML 1.2 > > +--- > > +$id: http://devicetree.org/schemas/iio/proximity/semtech,sx9310.yaml# > > Should be sx9324.yaml Done > > > +$schema: http://devicetree.org/meta-schemas/core.yaml# > > + > > +title: Semtech's SX9324 capacitive proximity sensor > > + > > +maintainers: > > + - Gwendal Grignou <gwendal@chromium.org> > > + - Daniel Campello <campello@chromium.org> > > + > > +description: | > > + Semtech's SX9324 proximity sensor. > > + > > +properties: > > + compatible: > > + enum: > > + - semtech,sx9324 > > If there's only one compatible then it can be > > compatible: > const: semtech,sx9324 Done > > > + > > + reg: > > + maxItems: 1 > > + > > + interrupts: > > + description: > > + Generated by device to announce preceding read request has finished > > + and data is available or that a close/far proximity event has happened. > > + maxItems: 1 > > + > > + vdd-supply: > > + description: Main power supply > > + > > + svdd-supply: > > + description: Host interface power supply > > + > > + "#io-channel-cells": > > + const: 1 > > + > > + semtech,ph0-pin: > > + $ref: /schemas/types.yaml#/definitions/uint32-array > > + description: | > > + Indicates how each CS pin is used during phase 0. > > + Each of the 3 pins have the following value - > > Can you also indicate that the index of the array corresponds to each > channel? Done. > > > + 0 : unused (high impedance) > > + 1 : measured input > > + 2 : dynamic shield > > + 3 : grounded. > > + For instance, CS0 measured, CS1 shield and CS2 ground is [1, 2, 3] > > + items: > > + enum: [ 0, 1, 2, 3 ] > > + minItems: 3 > > + maxItems: 3 > > + > > + semtech,ph1-pin: > > + semtech,ph2-pin: > > + semtech,ph3-pin: > > + Same as ph0-pin > > I'm fairly certain we need to duplicate the ph0-pin description each > time. And presumably ph1 is for phase 1? Fixed. Regarding duplicating description, there are other binding docs that do not recopy it. For instance, [Documentation/devicetree/bindings/input/touchscreen/edt-ft5x06.yaml], """ offset-x: description: Same as offset, but applies ... """" > > > + > > + semtech,resolution01 > > + $ref: /schemas/types.yaml#definitions/uint32 > > + enum: [8, 16, 32, 64, 128, 256, 512, 1024] > > + description: > > + Capacitance measurement resolution. For phase 0 and 1. > > + Higher the number, higher the resolution. > > + default: 128 > > + > > + semtech,resolution23 > > + $ref: /schemas/types.yaml#definitions/uint32 > > + enum: [8, 16, 32, 64, 128, 256, 512, 1024] > > + description: > > + Capacitance measurement resolution. For phase 2 and 3 > > + default: 128 > > Can this be a single combined u32 array for each phase? But phases 0 and 1 [as well as 2 and 3] must have the same resolution. If we have an array of 4 entries, we would be tempted to use different resolutions for each phases. > > > + > > + semtech,startup-sensor: > > + $ref: /schemas/types.yaml#definitions/uint32 > > + enum: [0, 1, 2, 3] > > + default: 0 > > + description: > > + Phase used for start-up proximity detection. > > + It is used when we enable a phase to remove static offset and measure > > + only capacitance changes introduced by the user. > > + > > + semtech,proxraw-strength01: > > + $ref: /schemas/types.yaml#definitions/uint32 > > + min: 0 > > + max: 7 > > + default: 1 > > + description: > > + PROXRAW filter strength for phase 0 and 1. A value of 0 represents off, > > + and other values represent 1-1/2^N. > > + > > + semtech,proxraw-strength23: > > + Same as proxraw-strength01, for phase 2 and 3. > > Likewise, can this be combined into one array for all phases? See above. > > > + > > + semtech,avg-pos-strength: > > + $ref: /schemas/types.yaml#definitions/uint32 > > + enum: [0, 16, 64, 128, 256, 512, 1024, 4294967295] > > + default: 16 > > + description: > > + Average positive filter strength. A value of 0 represents off and > > + UINT_MAX (4294967295) represents infinite. Other values > > + represent 1-1/N. > > + > > +required: > > + - compatible > > + - reg > > + - "#io-channel-cells" > > + > > +additionalProperties: false > > + > > +examples: > > + - | > > + #include <dt-bindings/interrupt-controller/irq.h> > > + i2c { > > + #address-cells = <1>; > > + #size-cells = <0>; > > + proximity@28 { > > + compatible = "semtech,sx9310"; > > Should be semtech,sx9324 Done. > > > + reg = <0x28>; > > + interrupt-parent = <&pio>; > > + interrupts = <5 IRQ_TYPE_LEVEL_LOW 5>; > > + vdd-supply = <&pp3300_a>; > > + svdd-supply = <&pp1800_prox>; > > + #io-channel-cells = <1>; > > + semtech,ph0-pin = <1, 2, 3>; > > + semtech,ph1-pin = <3, 2, 1>; > > + semtech,ph2-pin = <1, 2, 3>; > > + semtech,ph3-pin = <3, 2, 1>; > > + semtech,resolution01 = 2; > > + semtech,resolution23 = 2; > > + semtech,startup-sensor = <1>; > > + semtech,proxraw-strength01 = <2>; > > + semtech,proxraw-strength23 = <2>; > > + semtech,avg-pos-strength = <64>; > > + }; > > + };
diff --git a/Documentation/devicetree/bindings/iio/proximity/semtech,sx9324.yaml b/Documentation/devicetree/bindings/iio/proximity/semtech,sx9324.yaml new file mode 100644 index 00000000000000..5e2e684400e35a --- /dev/null +++ b/Documentation/devicetree/bindings/iio/proximity/semtech,sx9324.yaml @@ -0,0 +1,136 @@ +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/iio/proximity/semtech,sx9310.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Semtech's SX9324 capacitive proximity sensor + +maintainers: + - Gwendal Grignou <gwendal@chromium.org> + - Daniel Campello <campello@chromium.org> + +description: | + Semtech's SX9324 proximity sensor. + +properties: + compatible: + enum: + - semtech,sx9324 + + reg: + maxItems: 1 + + interrupts: + description: + Generated by device to announce preceding read request has finished + and data is available or that a close/far proximity event has happened. + maxItems: 1 + + vdd-supply: + description: Main power supply + + svdd-supply: + description: Host interface power supply + + "#io-channel-cells": + const: 1 + + semtech,ph0-pin: + $ref: /schemas/types.yaml#/definitions/uint32-array + description: | + Indicates how each CS pin is used during phase 0. + Each of the 3 pins have the following value - + 0 : unused (high impedance) + 1 : measured input + 2 : dynamic shield + 3 : grounded. + For instance, CS0 measured, CS1 shield and CS2 ground is [1, 2, 3] + items: + enum: [ 0, 1, 2, 3 ] + minItems: 3 + maxItems: 3 + + semtech,ph1-pin: + semtech,ph2-pin: + semtech,ph3-pin: + Same as ph0-pin + + semtech,resolution01 + $ref: /schemas/types.yaml#definitions/uint32 + enum: [8, 16, 32, 64, 128, 256, 512, 1024] + description: + Capacitance measurement resolution. For phase 0 and 1. + Higher the number, higher the resolution. + default: 128 + + semtech,resolution23 + $ref: /schemas/types.yaml#definitions/uint32 + enum: [8, 16, 32, 64, 128, 256, 512, 1024] + description: + Capacitance measurement resolution. For phase 2 and 3 + default: 128 + + semtech,startup-sensor: + $ref: /schemas/types.yaml#definitions/uint32 + enum: [0, 1, 2, 3] + default: 0 + description: + Phase used for start-up proximity detection. + It is used when we enable a phase to remove static offset and measure + only capacitance changes introduced by the user. + + semtech,proxraw-strength01: + $ref: /schemas/types.yaml#definitions/uint32 + min: 0 + max: 7 + default: 1 + description: + PROXRAW filter strength for phase 0 and 1. A value of 0 represents off, + and other values represent 1-1/2^N. + + semtech,proxraw-strength23: + Same as proxraw-strength01, for phase 2 and 3. + + semtech,avg-pos-strength: + $ref: /schemas/types.yaml#definitions/uint32 + enum: [0, 16, 64, 128, 256, 512, 1024, 4294967295] + default: 16 + description: + Average positive filter strength. A value of 0 represents off and + UINT_MAX (4294967295) represents infinite. Other values + represent 1-1/N. + +required: + - compatible + - reg + - "#io-channel-cells" + +additionalProperties: false + +examples: + - | + #include <dt-bindings/interrupt-controller/irq.h> + i2c { + #address-cells = <1>; + #size-cells = <0>; + proximity@28 { + compatible = "semtech,sx9310"; + reg = <0x28>; + interrupt-parent = <&pio>; + interrupts = <5 IRQ_TYPE_LEVEL_LOW 5>; + vdd-supply = <&pp3300_a>; + svdd-supply = <&pp1800_prox>; + #io-channel-cells = <1>; + semtech,ph0-pin = <1, 2, 3>; + semtech,ph1-pin = <3, 2, 1>; + semtech,ph2-pin = <1, 2, 3>; + semtech,ph3-pin = <3, 2, 1>; + semtech,resolution01 = 2; + semtech,resolution23 = 2; + semtech,startup-sensor = <1>; + semtech,proxraw-strength01 = <2>; + semtech,proxraw-strength23 = <2>; + semtech,avg-pos-strength = <64>; + }; + };
Similar to SX9310, add biddings to setup sx9324 hardware properties. SX9324 is a little different, introduce 4 phases to be configured in 2 pairs over 3 antennas. Signed-off-by: Gwendal Grignou <gwendal@chromium.org> --- Changes in v3: - Remove duplicate information. - Use intervals instead of enum. - Fix filter description. Changes in v2: - Fix interrupt documentation wording. .../iio/proximity/semtech,sx9324.yaml | 136 ++++++++++++++++++ 1 file changed, 136 insertions(+) create mode 100644 Documentation/devicetree/bindings/iio/proximity/semtech,sx9324.yaml