Skip to contentSkip to conversation

input: introduce support for Qualcomm SPMI haptics

PATCH In review Caleb Connolly 3 participants 5 messages Oct 15, 2022 – Oct 18, 2022

Subsystems (4)
lore
Share & tools
lore
#0 lore raw

v7 cover input: introduce support for Qualcomm SPMI haptics

This series introduces a driver for the SPMI haptics hardware block found in Qualcomm PMICs. SPMI haptics support LRA (Linear Resonant Actuator) style haptics, as well as ERM (Eccentric Rotating Mass). It also supports several modes of driving the haptics, e.g. by loading the pattern to play into an internal buffer, or using PWM.

More information about the hardware can be found here:

        https://gitlab.com/sdm845-mainline/linux/-/wikis/PMI8998-QPNP-Haptics

This driver has been written based on downstream sources as no public documentation is available. It includes initial support for LRA haptics in buffer mode, this combination seems to be the most common and will enable haptics on the OnePlus 6 and 6T, PocoPhone F1, OnePlus 5 and several other Qualcomm devices with mainline kernel support.

The driver is implemented using the ff-memless (forcefeedback) input framework and makes an attempt to control the strength of vibration relative to the magnitude set from userspace.

Changes since v6:
- Apply Krzysztof's dt-bindings suggestions
- Rename qcom,wave-play-rate-us to qcom,wave-play-duration-us and add a comment explaining the name change compared to downstream.
- Add COMPILE_TEST to kconfig

Changes since v5:
- Fix dt schema errors
- Fix typo (thanks Vincent)

Changes since v4:
- Significant rewrite and cleanup
- switch to dev_err_probe()
- Run through clang-format

Changes since v3:
- Adjust example DTS to avoid creating new warnings in dt_binding_check
- Address warnings from kernel test robot.

Changes since v2:
- Addressed Rob's comments on dt-bindings (I'm not sure what to do about the pmic compatible?)
- Fixed some typos

Changes since v1:
- Replace old QPNP naming with SPMI
- Address Bjorn's comments on the driver, various style and code cleanups
- Address Bjorn's comments on the DT bindings and DTS
- Pickup patches from Joel and Jami to enable haptics on the OnePlus 5 and Poco F1.

Caleb Connolly (2):
dt-bindings: input: document Qualcomm PMI8998 haptics driver
input: add Qualcomm SPMI haptics driver

 .../bindings/input/qcom,pmi8998-haptics.yaml  |  73 ++
 drivers/input/misc/Kconfig                    |  15 +
 drivers/input/misc/Makefile                   |   1 +
 drivers/input/misc/qcom-pmi8998-haptics.c     | 690 ++++++++++++++++++
 4 files changed, 779 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/input/qcom,pmi8998-haptics.yaml
 create mode 100644 drivers/input/misc/qcom-pmi8998-haptics.c

--
2.38.0

#1 lore raw

PATCH v7 1/2 dt-bindings: input: document Qualcomm PMI8998 haptics driver

Add bindings for qcom PMIC PMI8998 haptics driver.

---
 .../bindings/input/qcom,pmi8998-haptics.yaml  | 73 +++++++++++++++++++
 1 file changed, 73 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/input/qcom,pmi8998-haptics.yaml
Documentation/devicetree/bindings/input/qcom,pmi8998-haptics.yaml new file +73 -0
new file mode 100644
index 000000000000..d43324cceb89
@@ -0,0 +1,73 @@
+# 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,pmi8998-haptics.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Qualcomm PMI8998/PM660 Haptics
+
+maintainers:
+  - Caleb Connolly <[email protected]>
+
+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,pm660-charger
+          - qcom,pmi8996-haptics
+          - qcom,pmi8941-haptics
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    maxItems: 2
+
+  interrupt-names:
+    items:
+      - const: short
+      - const: play
+
+  qcom,wave-play-duration-us:
+    description: |
+      Wave sample duration in microseconds, 1/f where f
+      is the resonant frequency of the actuator.
+      This property is named qcom,wave-play-rate-us in
+      downstream kernels.
+    minimum: 0
+    maximum: 20475
+
+required:
+  - compatible
+  - reg
+  - interrupts
+  - qcom,wave-play-rate-us
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/interrupt-controller/irq.h>
+
+    spmi {
+      #address-cells = <1>;
+      #size-cells = <0>;
+      pmi8998_haptics: haptics@c000 {
+        compatible = "qcom,pmi8998-haptics";
+        reg = <0xc000>;
+
+        interrupts = <0x3 0xc0 0x0 IRQ_TYPE_EDGE_BOTH>,
+                     <0x3 0xc0 0x1 IRQ_TYPE_EDGE_BOTH>;
+        interrupt-names = "short", "play";
+
+        qcom,wave-play-rate-us = <4255>;
+      };
+    };

--
2.38.0

maintainer
#3 lore raw

Re: [PATCH v7 1/2] dt-bindings: input: document Qualcomm PMI8998 haptics driver

In reply to Caleb Connolly
Quoted 8 lines · Caleb Connolly

Add bindings for qcom PMIC PMI8998 haptics driver.

---
 .../bindings/input/qcom,pmi8998-haptics.yaml  | 73 +++++++++++++++++++
 1 file changed, 73 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/input/qcom,pmi8998-haptics.yaml

My bot found errors running 'make DT_CHECKER_FLAGS=-m dt_binding_check' on your patch (DT_CHECKER_FLAGS is new in v5.13):

yamllint warnings/errors:

dtschema/dtc warnings/errors:
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/input/qcom,pmi8998-haptics.example.dtb: haptics@c000: 'qcom,wave-play-rate-us' does not match any of the regexes: 'pinctrl-[0-9]+'
From schema: /builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/input/qcom,pmi8998-haptics.yaml

doc reference errors (make refcheckdocs):

See https://patchwork.ozlabs.org/patch/

This check can fail if there are any dependencies. The base for a patch series is generally the most recent rc1.

If you already ran 'make dt_binding_check' and didn't see the above error(s), then make sure 'yamllint' is installed and dt-schema is up to date:

pip3 install dtschema --upgrade

Please check and re-submit.

#4 lore raw

Re: [PATCH v7 1/2] dt-bindings: input: document Qualcomm PMI8998 haptics driver

In reply to Caleb Connolly
Quoted 28 lines · Caleb Connolly

Add bindings for qcom PMIC PMI8998 haptics driver.

---
  .../bindings/input/qcom,pmi8998-haptics.yaml  | 73 +++++++++++++++++++
  1 file changed, 73 insertions(+)

create mode 100644 Documentation/devicetree/bindings/input/qcom,pmi8998-haptics.yaml

Documentation/devicetree/bindings/input/qcom,pmi8998-haptics.yaml new file +14 -0
new file mode 100644
index 000000000000..d43324cceb89
@@ -0,0 +1,73 @@
+# 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,pmi8998-haptics.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Qualcomm PMI8998/PM660 Haptics
+
+maintainers:
+  - Caleb Connolly <[email protected]>
+
+description: |
+  Qualcomm SPMI haptics is a peripheral on some QTI PMICs. It supports linear resonant

Documentation/devicetree/bindings/input/qcom,pmi8998-haptics.yaml line 24

Quoted 10 lines
Documentation/devicetree/bindings/input/qcom,pmi8998-haptics.yaml new file +10 -0
+  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,pm660-charger

I've just noticed this typo! Will respin and fix...

Quoted 50 lines
Documentation/devicetree/bindings/input/qcom,pmi8998-haptics.yaml new file +49 -1
+          - qcom,pmi8996-haptics
+          - qcom,pmi8941-haptics
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    maxItems: 2
+
+  interrupt-names:
+    items:
+      - const: short
+      - const: play
+
+  qcom,wave-play-duration-us:
+    description: |
+      Wave sample duration in microseconds, 1/f where f
+      is the resonant frequency of the actuator.
+      This property is named qcom,wave-play-rate-us in
+      downstream kernels.
+    minimum: 0
+    maximum: 20475
+
+required:
+  - compatible
+  - reg
+  - interrupts
+  - qcom,wave-play-rate-us
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/interrupt-controller/irq.h>
+
+    spmi {
+      #address-cells = <1>;
+      #size-cells = <0>;
+      pmi8998_haptics: haptics@c000 {
+        compatible = "qcom,pmi8998-haptics";
+        reg = <0xc000>;
+
+        interrupts = <0x3 0xc0 0x0 IRQ_TYPE_EDGE_BOTH>,
+                     <0x3 0xc0 0x1 IRQ_TYPE_EDGE_BOTH>;
+        interrupt-names = "short", "play";
+
+        qcom,wave-play-rate-us = <4255>;
+      };
+    };
--
Quoted 2 lines

2.38.0

--
Kind Regards,
Caleb