mbox series

[v4,0/6] input: Introduce support for SPMI haptics found on Qcom PMICs

Message ID 20211210022639.2779173-1-caleb@connolly.tech
Headers show
Series input: Introduce support for SPMI haptics found on Qcom PMICs | expand

Message

Caleb Connolly Dec. 10, 2021, 2:26 a.m. UTC
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 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 (4):
  dt-bindings: input: add Qualcomm SPMI haptics driver
  input: add Qualcomm SPMI haptics driver
  arm64: dts: qcom: pmi8998: introduce spmi haptics
  arm64: dts: qcom: sdm845-oneplus-common: add haptics

Jami Kettunen (1):
  arm64: dts: qcom: msm8998-oneplus-common: Enable PMI8998 haptics

Joel Selvaraj (1):
  arm64: dts: qcom: sdm845-xiaomi-beryllium: add haptics

 .../bindings/input/qcom,spmi-haptics.yaml     | 123 +++
 .../boot/dts/qcom/msm8998-oneplus-common.dtsi |   6 +
 arch/arm64/boot/dts/qcom/pmi8998.dtsi         |  15 +
 .../boot/dts/qcom/sdm845-oneplus-common.dtsi  |   6 +
 .../boot/dts/qcom/sdm845-xiaomi-beryllium.dts |   5 +
 drivers/input/misc/Kconfig                    |  12 +
 drivers/input/misc/Makefile                   |   1 +
 drivers/input/misc/qcom-spmi-haptics.c        | 977 ++++++++++++++++++
 include/dt-bindings/input/qcom,spmi-haptics.h |  32 +
 9 files changed, 1177 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/input/qcom,spmi-haptics.yaml
 create mode 100644 drivers/input/misc/qcom-spmi-haptics.c
 create mode 100644 include/dt-bindings/input/qcom,spmi-haptics.h

--
2.34.1

Comments

Rob Herring (Arm) Dec. 10, 2021, 2:02 p.m. UTC | #1
On Fri, 10 Dec 2021 02:26:52 +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     | 123 ++++++++++++++++++
>  include/dt-bindings/input/qcom,spmi-haptics.h |  32 +++++
>  2 files changed, 155 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/input/qcom,spmi-haptics.yaml
>  create mode 100644 include/dt-bindings/input/qcom,spmi-haptics.h
> 

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/linux-dt-review/Documentation/devicetree/bindings/input/qcom,spmi-haptics.yaml: properties:qcom,wave-play-rate-us: '$ref' should not be valid under {'const': '$ref'}
	hint: Standard unit suffix properties don't need a type $ref
	from schema $id: http://devicetree.org/meta-schemas/core.yaml#
/builds/robherring/linux-dt-review/Documentation/devicetree/bindings/input/qcom,spmi-haptics.yaml: ignoring, error in schema: properties: qcom,wave-play-rate-us
warning: no schema found in file: ./Documentation/devicetree/bindings/input/qcom,spmi-haptics.yaml
Documentation/devicetree/bindings/input/qcom,spmi-haptics.example.dt.yaml:0:0: /example-0/spmi/haptics@c000: failed to match any schema with compatible: ['qcom,pmi8998-haptics']

doc reference errors (make refcheckdocs):

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

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.