Skip to contentSkip to conversation

dt-bindings: ps2-gpio: convert binding to json-schema

PATCH RESEND Applied Danilo Krummrich 3 participants 6 messages May 29, 2022 – Jun 5, 2022

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

PATCH RESEND v3 1/2 dt-bindings: ps2-gpio: convert binding to json-schema

Convert the ps2-gpio dt-binding documentation to DT schema format using the json-schema.

---
 .../devicetree/bindings/serio/ps2-gpio.txt    | 23 --------
 .../devicetree/bindings/serio/ps2-gpio.yaml   | 58 +++++++++++++++++++
 2 files changed, 58 insertions(+), 23 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/serio/ps2-gpio.txt
 create mode 100644 Documentation/devicetree/bindings/serio/ps2-gpio.yaml
Documentation/devicetree/bindings/serio/ps2-gpio.txt deleted +0 -23
deleted file mode 100644
index 7b7bc9cdf986..000000000000
@@ -1,23 +0,0 @@
-Device-Tree binding for ps/2 gpio device
-
-Required properties:
-	- compatible = "ps2-gpio"
-	- data-gpios: the data pin
-	- clk-gpios: the clock pin
-	- interrupts: Should trigger on the falling edge of the clock line.
-
-Optional properties:
-	- write-enable: Indicates whether write function is provided
-	to serio device. Possibly providing the write fn will not work, because
-	of the tough timing requirements.
-
-Example nodes:
-
-ps2@0 {
-	compatible = "ps2-gpio";
-	interrupt-parent = <&gpio>;
-	interrupts = <23 IRQ_TYPE_EDGE_FALLING>;
-	data-gpios = <&gpio 24 GPIO_ACTIVE_HIGH>;
-	clk-gpios = <&gpio 23 GPIO_ACTIVE_HIGH>;
-	write-enable;
-};
Documentation/devicetree/bindings/serio/ps2-gpio.yaml new file +58 -0

58 lines not on this page · raw message

Signature · 1 line
2.36.1
#1 lore raw

PATCH RESEND v3 2/2 dt-bindings: ps2-gpio: document bus signals open drain

The PS/2 bus defines data and clock line to be open drain, this should be reflected in the gpio flags set in the binding.

Especially, this is important since the clock line sometimes is driven by the host while being used as interrupt source.

---
 .../devicetree/bindings/serio/ps2-gpio.yaml        | 14 ++++++++++----
 1 file changed, 10 insertions(+), 4 deletions(-)
Documentation/devicetree/bindings/serio/ps2-gpio.yaml +10 -4
index 304132fd30c5..a63d9172346f 100644
@@ -15,12 +15,18 @@ properties:
 
   data-gpios:
     description:
-      the gpio used for the data signal
+      the gpio used for the data signal - this should be flagged as
+      active high using open drain with (GPIO_ACTIVE_HIGH | GPIO_OPEN_DRAIN)
+      from <dt-bindings/gpio/gpio.h> since the signal is open drain by
+      definition
     maxItems: 1
 
   clk-gpios:
     description:
-      the gpio used for the clock signal
+      the gpio used for the clock signal - this should be flagged as
+      active high using open drain with (GPIO_ACTIVE_HIGH | GPIO_OPEN_DRAIN)
+      from <dt-bindings/gpio/gpio.h> since the signal is open drain by
+      definition
     maxItems: 1
 
   interrupts:
@@ -52,7 +58,7 @@ examples:
         compatible = "ps2-gpio";
         interrupt-parent = <&gpio>;
         interrupts = <23 IRQ_TYPE_EDGE_FALLING>;
-        data-gpios = <&gpio 24 GPIO_ACTIVE_HIGH>;
-        clk-gpios = <&gpio 23 GPIO_ACTIVE_HIGH>;
+        data-gpios = <&gpio 24 (GPIO_ACTIVE_HIGH | GPIO_OPEN_DRAIN)>;
+        clk-gpios = <&gpio 23 (GPIO_ACTIVE_HIGH | GPIO_OPEN_DRAIN)>;
         write-enable;
     };
Signature · 1 line
2.36.1
Reviewed-by on v3 2/2
#2 lore raw

Re: [RESEND PATCH v3 2/2] dt-bindings: ps2-gpio: document bus signals open drain

Quoted 8 lines · Danilo Krummrich

The PS/2 bus defines data and clock line to be open drain, this should be reflected in the gpio flags set in the binding.

Especially, this is important since the clock line sometimes is driven by the host while being used as interrupt source.

Yours,
Linus Walleij

maintainer Applied
#3 lore raw

Re: [RESEND PATCH v3 2/2] dt-bindings: ps2-gpio: document bus signals open drain

In reply to Danilo Krummrich
Quoted 12 lines · Danilo Krummrich

The PS/2 bus defines data and clock line to be open drain, this should be reflected in the gpio flags set in the binding.

Especially, this is important since the clock line sometimes is driven by the host while being used as interrupt source.

---
 .../devicetree/bindings/serio/ps2-gpio.yaml        | 14 ++++++++++----
 1 file changed, 10 insertions(+), 4 deletions(-)

Applied, thanks!

maintainer Applied
#5 lore raw
In reply to Danilo Krummrich
Quoted 12 lines · Danilo Krummrich

Convert the ps2-gpio dt-binding documentation to DT schema format using the json-schema.

---
 .../devicetree/bindings/serio/ps2-gpio.txt    | 23 --------
 .../devicetree/bindings/serio/ps2-gpio.yaml   | 58 +++++++++++++++++++
 2 files changed, 58 insertions(+), 23 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/serio/ps2-gpio.txt
 create mode 100644 Documentation/devicetree/bindings/serio/ps2-gpio.yaml

Applied, thanks!