Skip to contentSkip to conversation

dt-bindings: input: convert rotary-encoder to yaml

PATCH Applied Frank Li 3 participants 4 messages Aug 11, 2024 – Sep 6, 2024

Subsystems (4)
lore
Share & tools
lore

Frank Li

author maintainer
#0 lore raw

PATCH 1/1 dt-bindings: input: convert rotary-encoder to yaml

Convert binding doc rotary-encoder.txt to yaml format.

Additional change:
- Only keep one example.

Fix below warning:
arch/arm64/boot/dts/freescale/imx8mn-dimonoff-gateway-evk.dtb: /rotary-encoder:
failed to match any schema with compatible: ['rotary-encoder']

---
 .../bindings/input/rotary-encoder.txt         | 50 -----------
 .../bindings/input/rotary-encoder.yaml        | 90 +++++++++++++++++++
 2 files changed, 90 insertions(+), 50 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/input/rotary-encoder.txt
 create mode 100644 Documentation/devicetree/bindings/input/rotary-encoder.yaml
Documentation/devicetree/bindings/input/rotary-encoder.txt deleted +0 -50
deleted file mode 100644
index a644408b33b8f..0000000000000
@@ -1,50 +0,0 @@
-Rotary encoder DT bindings
-
-Required properties:
-- gpios: a spec for at least two GPIOs to be used, most significant first
-
-Optional properties:
-- linux,axis: the input subsystem axis to map to this rotary encoder.
-  Defaults to 0 (ABS_X / REL_X)
-- rotary-encoder,steps: Number of steps in a full turnaround of the
-  encoder. Only relevant for absolute axis. Defaults to 24 which is a
-  typical value for such devices.
-- rotary-encoder,relative-axis: register a relative axis rather than an
-  absolute one. Relative axis will only generate +1/-1 events on the input
-  device, hence no steps need to be passed.
-- rotary-encoder,rollover: Automatic rollover when the rotary value becomes
-  greater than the specified steps or smaller than 0. For absolute axis only.
-- rotary-encoder,steps-per-period: Number of steps (stable states) per period.
-  The values have the following meaning:
-  1: Full-period mode (default)
-  2: Half-period mode
-  4: Quarter-period mode
-- wakeup-source: Boolean, rotary encoder can wake up the system.
-- rotary-encoder,encoding: String, the method used to encode steps.
-  Supported are "gray" (the default and more common) and "binary".
-
-Deprecated properties:
-- rotary-encoder,half-period: Makes the driver work on half-period mode.
-  This property is deprecated. Instead, a 'steps-per-period ' value should
-  be used, such as "rotary-encoder,steps-per-period = <2>".
-
-See Documentation/input/devices/rotary-encoder.rst for more information.
-
-Example:
-
-		rotary@0 {
-			compatible = "rotary-encoder";
-			gpios = <&gpio 19 1>, <&gpio 20 0>; /* GPIO19 is inverted */
-			linux,axis = <0>; /* REL_X */
-			rotary-encoder,encoding = "gray";
-			rotary-encoder,relative-axis;
-		};
-
-		rotary@1 {
-			compatible = "rotary-encoder";
-			gpios = <&gpio 21 0>, <&gpio 22 0>;
-			linux,axis = <1>; /* ABS_Y */
-			rotary-encoder,steps = <24>;
-			rotary-encoder,encoding = "binary";
-			rotary-encoder,rollover;
-		};
Documentation/devicetree/bindings/input/rotary-encoder.yaml new file +90 -0

90 lines not on this page · raw message

Signature · 1 line
2.34.1
maintainer Reviewed-by on v1 1/1
#1 lore raw
Quoted 9 lines · Frank Li

Convert binding doc rotary-encoder.txt to yaml format.

Additional change:
- Only keep one example.

Fix below warning:
arch/arm64/boot/dts/freescale/imx8mn-dimonoff-gateway-evk.dtb: /rotary-encoder:
failed to match any schema with compatible: ['rotary-encoder']

Quoted 8 lines
---
 .../bindings/input/rotary-encoder.txt         | 50 -----------
 .../bindings/input/rotary-encoder.yaml        | 90 +++++++++++++++++++
 2 files changed, 90 insertions(+), 50 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/input/rotary-encoder.txt
 create mode 100644 Documentation/devicetree/bindings/input/rotary-encoder.yaml
author maintainer
#2 lore raw
Quoted 20 lines · Rob Herring (Arm)
Quoted 9 lines · Frank Li

Convert binding doc rotary-encoder.txt to yaml format.

Additional change:
- Only keep one example.

Fix below warning:
arch/arm64/boot/dts/freescale/imx8mn-dimonoff-gateway-evk.dtb: /rotary-encoder:
failed to match any schema with compatible: ['rotary-encoder']

Quoted 8 lines
---
 .../bindings/input/rotary-encoder.txt         | 50 -----------
 .../bindings/input/rotary-encoder.yaml        | 90 +++++++++++++++++++
 2 files changed, 90 insertions(+), 50 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/input/rotary-encoder.txt
 create mode 100644 Documentation/devicetree/bindings/input/rotary-encoder.yaml
Quoted 1 line

Dmitry:
Could you take care this patch?

Frank

Quoted 1 line
maintainer Applied
#3 lore raw
In reply to Frank Li
Quoted 10 lines · Frank Li

Convert binding doc rotary-encoder.txt to yaml format.

Additional change:
- Only keep one example.

Fix below warning:
arch/arm64/boot/dts/freescale/imx8mn-dimonoff-gateway-evk.dtb: /rotary-encoder:
failed to match any schema with compatible: ['rotary-encoder']

Applied, thank you.

Signature · 1 line
Dmitry