lkml.org 
[lkml]   [2021]   [Jun]   [22]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
Patch in this message
/
Date
From
SubjectRe: [RESEND PATCH v2 1/6] dt-bindings: input: add Qualcomm SPMI haptics driver
On Fri, Jun 18, 2021 at 05:51:03PM +0000, Caleb Connolly wrote:
> Add bindings for qcom PMIC SPMI haptics driver.
>
> Signed-off-by: Caleb Connolly <caleb@connolly.tech>
> ---
> .../bindings/input/qcom,spmi-haptics.yaml | 128 ++++++++++++++++++
> include/dt-bindings/input/qcom,spmi-haptics.h | 32 +++++
> 2 files changed, 160 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/input/qcom,spmi-haptics.yaml
> create mode 100644 include/dt-bindings/input/qcom,spmi-haptics.h
>
> diff --git a/Documentation/devicetree/bindings/input/qcom,spmi-haptics.yaml b/Documentation/devicetree/bindings/input/qcom,spmi-haptics.yaml
> new file mode 100644
> index 000000000000..8ef9b4ec3a07
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/input/qcom,spmi-haptics.yaml
> @@ -0,0 +1,128 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +# Copyright 2020 Unisoc Inc.
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/input/qcom,spmi-haptics.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Qualcomm Technologies Inc PMI8998 spmi haptics
> +
> +maintainers:
> + - Caleb Connolly <caleb@connolly.tech>
> +
> +description: |
> + Qualcomm SPMI haptics is a peripheral on some QTI PMICs. It supports linear resonant
> + actuators and eccentric rotating mass type haptics commonly found in mobile devices.
> + It supports multiple sources of wave data such as an internal buffer, direct play
> + (from kernel or userspace) as well as an audio output mode.
> +
> +properties:
> + compatible:
> + items:
> + - enum:
> + - qcom,pmi8998-haptics
> + - qcom,pmi8996-haptics
> + - qcom,pmi8941-haptics
> + - const: qcom,spmi-haptics
> +
> + reg:
> + maxItems: 1
> +
> + interrupts:
> + items:
> + - description: short circuit interrupt
> + - description: play interrupt
> +
> + interrupt-names:
> + items:
> + - const: short
> + - const: play
> +
> + qcom,actuator-type:
> + description: |
> + The type of actuator attached to the hardware.
> + Allowed values are,
> + 0 - HAP_TYPE_LRA
> + 1 - HAP_TYPE_ERM
> + $ref: /schemas/types.yaml#/definitions/uint32
> + enum: [ 0, 1 ]
> + default: 0
> +
> + qcom,wave-shape:
> + description: |
> + Selects the wave shape to use.
> + Allowed values are,
> + 0 - HAP_WAVE_SINE
> + 1 - HAP_WAVE_SQUARE
> + $ref: /schemas/types.yaml#/definitions/uint32
> + enum: [ 0, 1 ]
> + default: 0
> +
> + qcom,play-mode:
> + description: |
> + Selects the play mode to use.
> + Allowed values are,
> + 0 - HAP_PLAY_DIRECT
> + 1 - HAP_PLAY_BUFFER
> + 2 - HAP_PLAY_AUDIO
> + 3 - HAP_PLAY_PWM
> + $ref: /schemas/types.yaml#/definitions/uint32
> + enum: [ 0, 1, 2, 3 ]
> + default: 2
> +
> + qcom,wave-play-rate-us:
> + description: |
> + Wave sample durection in microseconds, 1/f where f
> + is the resonant frequency of the actuator.
> + $ref: /schemas/types.yaml#/definitions/uint32
Don't need a type for standard units.

> + minimum: 0
> + maximum: 20475
> +
> + qcom,brake-pattern:
> + minItems: 4
> + maxItems: 4
> + description: |
> + The brake pattern are the strengths of the pattern
> + used to brake the haptics. Allowed values are,
> + 0 - 0V
> + 1 - Vmax/4
> + 2 - Vmax/2
> + 3 - Vmax
> + $ref: /schemas/types.yaml#/definitions/uint32-array
> + default: [0x3, 0x3, 0x2, 0x1]

To express the constraints on all items:

items:
enum: [ 0, 1, 2, 3 ]

(items is a schema here rather than a list)

> +
> +required:
> + - compatible
> + - reg
> + - interrupts
> + - qcom,wave-play-rate-us
> +
> +additionalProperties: false
> +
> +examples:
> + - |
> + #include <dt-bindings/spmi/spmi.h>
> + #include <dt-bindings/interrupt-controller/irq.h>
> + #include <dt-bindings/input/qcom,spmi-haptics.h>
> +
> + pmi8998_lsid1: pmic@3 {

Drop unused labels.

> + compatible = "qcom,pmi8998", "qcom,spmi-pmic";

Really, this needs to be converted to schema first so we're not adding
warnings.

> + reg = <0x3 SPMI_USID>;
> + #address-cells = <1>;
> + #size-cells = <0>;
> +
> + pmi8998_haptics: haptics@c000 {
> + compatible = "qcom,pmi8998-haptics", "qcom,spmi-haptics";
> + reg = <0xc000>;
> +
> + interrupts = <0x3 0xc0 0x0 IRQ_TYPE_EDGE_BOTH>,
> + <0x3 0xc0 0x1 IRQ_TYPE_EDGE_BOTH>;
> + interrupt-names = "short", "play";
> +
> + qcom,wave-shape = <HAP_WAVE_SINE>;
> + qcom,play-mode = <HAP_PLAY_BUFFER>;
> + qcom,brake-pattern = <0x3 0x3 0x2 0x1>;
> +
> + status = "disabled";

Don't show status in examples.

> + };
> + };
> diff --git a/include/dt-bindings/input/qcom,spmi-haptics.h b/include/dt-bindings/input/qcom,spmi-haptics.h
> new file mode 100644
> index 000000000000..14a7e7d1471e
> --- /dev/null
> +++ b/include/dt-bindings/input/qcom,spmi-haptics.h
> @@ -0,0 +1,32 @@
> +/* SPDX-License-Identifier: GPL-2.0-only */

Dual license please. DT files are used elsewhere.

> +/*
> + * This header provides constants for pmi8998 SPMI haptics options.
> + */
> +
> +#ifndef _DT_BINDINGS_QCOM_PMIC_SPMI_HAPTICS_
> +#define _DT_BINDINGS_QCOM_PMIC_SPMI_HAPTICS_
> +
> +// Actuator types
> +#define HAP_TYPE_LRA 0
> +#define HAP_TYPE_ERM 1
> +
> +// LRA Wave type
> +#define HAP_WAVE_SINE 0
> +#define HAP_WAVE_SQUARE 1
> +
> +// Play modes
> +#define HAP_PLAY_DIRECT 0
> +#define HAP_PLAY_BUFFER 1
> +#define HAP_PLAY_AUDIO 2
> +#define HAP_PLAY_PWM 3
> +
> +#define HAP_PLAY_MAX HAP_PLAY_PWM
> +
> +// Auto resonance type
> +#define HAP_AUTO_RES_NONE 0
> +#define HAP_AUTO_RES_ZXD 1
> +#define HAP_AUTO_RES_QWD 2
> +#define HAP_AUTO_RES_MAX_QWD 3
> +#define HAP_AUTO_RES_ZXD_EOP 4
> +
> +#endif /* _DT_BINDINGS_QCOM_PMIC_SPMI_HAPTICS_ */
> --
> 2.31.1
>
>
>

\
 
 \ /
  Last update: 2021-06-22 17:59    [W:0.186 / U:1.160 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site