On 07/04/2023 00:20, Fred Treven wrote: > Add devicetree bindings for CS40L26 driver. I appreciate the try to write my name manually, but there is no need to struggle. :) You will just make a mistake. Just copy-paste or use scripts/get_maintainers.pl. You can automate everything with something like: https://github.com/krzk/tools/blob/master/linux/.bash_aliases_linux#L91 > > Signed-off-by: Fred Treven <fred.treven@xxxxxxxxxx> > --- > .../devicetree/bindings/input/cs40l26.yaml | 92 ++++++++++++++++++++++ > MAINTAINERS | 1 + > 2 files changed, 93 insertions(+) > create mode 100644 Documentation/devicetree/bindings/input/cs40l26.yaml Filename matching compatible, so you need vendor-prefix. > > diff --git a/Documentation/devicetree/bindings/input/cs40l26.yaml b/Documentation/devicetree/bindings/input/cs40l26.yaml > new file mode 100644 > index 000000000000..1036a374baa0 > --- /dev/null > +++ b/Documentation/devicetree/bindings/input/cs40l26.yaml > @@ -0,0 +1,92 @@ > +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause > +%YAML 1.2 > +--- > +$id: http://devicetree.org/schemas/input/cs40l26.yaml# > +$schema: http://devicetree.org/meta-schemas/core.yaml# > + > +title: Cirrus Logic CS40L26 Boosted Haptic Amplifier > + > +maintainers: > + - Fred Treven <fred.treven@xxxxxxxxxx> > + > +description: > + CS40L26 is a Boosted Haptic Driver with Integrated DSP and Waveform Memory > + with Advanced Closed Loop Algorithms and LRA protection > + > +properties: > + compatible: > + enum: > + - cirrus,cs40l26a > + - cirrus,cs40l26b > + - cirrus,cs40l27a > + - cirrus,cs40l27b > + > + reg: > + maxItems: 1 > + > + interrupts: > + maxItems: 1 > + description: > + Property describing the interrupt line the devices /ALERT pin is connected to. > + The device only has one interrupt source. Drop description - it is almost useless. You could just mention ALERT pin. > + > + VA-supply: > + description: Regulator for VA analog voltage > + > + VP-supply: > + description: Regulator for VP peak voltage > + > + cirrus,bst-ipk-microamp: > + description: > + Maximum amount of current that can be drawn by the device's boost > + converter in uA. Accepted values are between 1600000 uA and 4800000 uA in > + 50000 uA increments. > + minimum: 1600000 > + maximum: 4800000 > + default: 4500000 Isn't this property of regulator? Why do you need it here? > + > + cirrus,bst-ctl-microvolt: > + description: > + Maximum target voltage to which the class H algorithm may increase the > + VBST supply, expressed in uV. Valid values range from 2550000 to 11000000 > + (inclusive) in steps of 50000. If this value is specified as zero or VP > + rises above this value, VBST is bypassed to VP. If this value is omitted, > + the maximum target voltage remains at 11 V. Don't repeat constraints in free form text - drop last sentence. > + minimum: 2550000 > + maximum: 11000000 > + default: 11000000 > + > + cirrus,bst-exploratory-mode-disable: > + description: > + Disable boost exploratory mode if this boolean is present in the > + devicetree. Don't explain how DT works. Explain how hardware works instead. > Boost exploratory mode allows the device to overshoot > + the set peak current limit. This has potential to damage the boost > + inductor. Disabling this mode will prevent this from happening; it will > + also prevent the device from detecting boost inductor short errors. > + (Default) Enabled Why this is suitable for DT? Why would anyone need to disable it per board? > + type: boolean > + > + Just one blank line. > +required: > + - compatible > + - reg > + - interrupts > + > +additionalProperties: false > + > +examples: > + - | > + i2c { > + cs40l26: cs40l26@58 { Node names should be generic. https://devicetree-specification.readthedocs.io/en/latest/chapter2-devicetree-basics.html#generic-names-recommendation > + compatible = "cirrus,cs40l26a"; > + reg = <0x58>; > + interrupt-parent = <&gpio0>; > + interrupts = <57 8>; If 8 is interrupt flag, use appropriate define. > + reset-gpios = <&gpio0 54 0>; Same for GPIO flag. > + VA-supply = <&dummy_vreg>; > + VP-supply = <&dummy_vreg>; > + cirrus,bst-ctl-microvolt = <2600000>; // Max boost voltage = 2.6V > + cirrus,bst-ipk-microamp = <1650000>; // Max boost current = 1.65A > + cirrus,bst-exploratory-mode-disabled; // Disable exploratory mode The comments are not useful - they copy the property. Instead you could explain WHY. Or just drop the comments. > Best regards, Krzysztof
