Re: [PATCH 1/3] dt-bindings: input: Add bindings for Awinic AW8695 haptics

[Krzysztof Kozlowski]

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 registers
> +
> +  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).

> +
> +  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 later 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).

> +
> +  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