Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
Mime-Version: 1.0
Content-Transfer-Encoding: quoted-printable
Content-Type: text/plain; charset=UTF-8
Date:   Mon, 11 Apr 2022 10:15:04 +0200
Message-Id: <CJ79EIW9Z89J.YZTZ6AU91TGE@otso>
Cc:     <~postmarketos/upstreaming@lists.sr.ht>,
        <phone-devel@vger.kernel.org>,
        "Dmitry Torokhov" <dmitry.torokhov@gmail.com>,
        "Rob Herring" <robh+dt@kernel.org>,
        "Krzysztof Kozlowski" <krzk+dt@kernel.org>,
        <devicetree@vger.kernel.org>, <linux-kernel@vger.kernel.org>
Subject: Re: [PATCH 1/3] dt-bindings: input: Add bindings for Awinic AW8695
 haptics
From:   "Luca Weiss" <luca.weiss@fairphone.com>
To:     "Krzysztof Kozlowski" <krzysztof.kozlowski@linaro.org>,
        <linux-input@vger.kernel.org>
References: <20220408115311.237039-1-luca.weiss@fairphone.com>
 <1a45984a-752b-6bad-0320-f0946d83f2b9@linaro.org>
In-Reply-To: <1a45984a-752b-6bad-0320-f0946d83f2b9@linaro.org>
Precedence: bulk

Hi Krzysztof,

thanks for the review, replies are inline!

On Fri Apr 8, 2022 at 5:05 PM CEST, Krzysztof Kozlowski wrote:
> On 08/04/2022 13:53, Luca Weiss wrote:
> > Add a document describing the bindings for the AW8695 LRA Haptic Driver=
.
>
> (...)
>
> > +  reset-gpios:
> > +    maxItems: 1
> > +    description: GPIO connected to RSTN pin (active high)
> > +
> > +  awinic,f0-preset:
> > +    $ref: /schemas/types.yaml#/definitions/uint32
> > +    description: Default value for the f0 of LRA
> > +
> > +  awinic,f0-coefficient:
> > +    $ref: /schemas/types.yaml#/definitions/uint32
> > +    description: Coefficient between actual f0 and the value in the re=
gisters
> > +
> > +  awinic,f0-calibration-percent:
> > +    maxItems: 1
> > +    description: Limit of f0 deviation from awinic,f0-preset
> > +
> > +  awinic,drive-level:
> > +    $ref: /schemas/types.yaml#/definitions/uint32
> > +    description: Level of drive waveform in normal driving
> > +
> > +  awinic,f0-detection-play-time:
> > +    $ref: /schemas/types.yaml#/definitions/uint32
> > +    description: Drive waveform play times in the first period in the =
f0 detection
>
> Use standard unit suffixes for known units (e.g. time).

While the datasheet doesn't mention any time unit, the value is used to
calculate the f0_trace_ms variable (which is milliseconds) but the
result also depends on the awinic,f0-preset value, so it's not a raw
time value.

>
> > +
> > +  awinic,f0-detection-wait-time:
> > +    $ref: /schemas/types.yaml#/definitions/uint32
> > +    description: Waveform wait times in the f0 detection
>
> Ditto.
>
> > +
> > +  awinic,f0-detection-repeat:
> > +    $ref: /schemas/types.yaml#/definitions/uint32
> > +    description: Repeat times in the f0 detection
> > +
> > +  awinic,f0-detection-trace:
> > +    $ref: /schemas/types.yaml#/definitions/uint32
> > +    description: Drive waveform play times in the second period and la=
ter in the f0 detection
> > +
> > +  awinic,boost-debug:
> > +    $ref: /schemas/types.yaml#/definitions/uint8-array
> > +    minItems: 3
> > +    maxItems: 3
> > +    description: Values for BSTDBG1-3 registers
>
> Do not encode device programming model (registers) into the binding. You
> need to define it as a property related to hardware itself, not its
> registers (e.g. boost value in mV).

Unfortunately I couldn't figure the meaning for this and the two values
below.

The datasheet doesn't mention these registers at all and the downstream
driver doesn't do anything meaningful with them (other than setting them)
nor has any comment to indicate what they do.
In the datasheet there's only BSTDBG4 mentioned where bits [5:1] mean
PVDD output voltage setting so for these registers it could really be
anthing :(

Maybe someone with more knowledge about LRAs might be able to decipher
what tset and r_spare is at least? I unfortunately didn't manage.

Regards
Luca

>
> > +
> > +  awinic,tset:
> > +    $ref: /schemas/types.yaml#/definitions/uint8
> > +    description: Value for TSET register
>
> Ditto.
>
> > +
> > +  awinic,r-spare:
> > +    $ref: /schemas/types.yaml#/definitions/uint8
> > +    description: Value for R_SPARE register
>
> Ditto.
>
>
> Best regards,
> Krzysztof