Skip to contentSkip to conversation

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

PATCH Applied Danilo Krummrich 3 participants 7 messages Feb 15, 2022 – Feb 16, 2022

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

Changes since v1
================
- binding as separate patch (driver patch will be sent outside the scope of this patch series)
- fixes requested by Krzysztof
- fix warnings/errors reported by 'make dt_binding_check'

Changes since v2
================
- add the driver patch to enforce open drain GPIO flags again
- fix additionalProperties: false

This series converts the ps2-gpio dt-binding to the json-schema.

Additionally, it documents (in the dt-binding) and enforces to flag the given gpios as open drain, since the PS/2 bus is open drain by definition.

Danilo Krummrich (3):
dt-bindings: ps2-gpio: convert binding to json-schema
dt-bindings: ps2-gpio: document bus signals open drain
input: ps2-gpio: enforce GPIOs flag open drain

 Documentation/devicetree/bindings/serio/ps2-gpio.txt  | 23 -----------------------
 Documentation/devicetree/bindings/serio/ps2-gpio.yaml | 64 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 drivers/input/serio/ps2-gpio.c                        |  9 +++++++--
 3 files changed, 71 insertions(+), 25 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/serio/ps2-gpio.txt
 create mode 100644 Documentation/devicetree/bindings/serio/ps2-gpio.yaml
#1 lore raw

PATCH v3 1/3 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.35.1
Reviewed-by on v3 1/3
#2 lore raw
Quoted 11 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

Best regards,
Krzysztof

#3 lore raw

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

In reply to 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(-)
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.35.1
Reviewed-by on v3 2/3
#4 lore raw

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

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(-)

Best regards,
Krzysztof

#5 lore raw

PATCH v3 3/3 input: ps2-gpio: enforce GPIOs flag open drain

In reply to Danilo Krummrich

The PS/2 bus defines the data and clock line be open drain, therefore for both enforce the particular GPIO flags in the driver.

Without enforcing to flag at least the clock gpio as open drain we run into the following warning:

WARNING: CPU: 1 PID: 40 at drivers/gpio/gpiolib.c:3175 gpiochip_enable_irq+0x54/0x90

gpiochip_enable_irq() warns on a GPIO being configured as output while serving as IRQ source without being flagged as open drain.

---
 drivers/input/serio/ps2-gpio.c | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)
drivers/input/serio/ps2-gpio.c +7 -2
index 8970b49ea09a..f562f396ba05 100644
@@ -322,14 +322,19 @@ static irqreturn_t ps2_gpio_irq(int irq, void *dev_id)
 static int ps2_gpio_get_props(struct device *dev,
 				 struct ps2_gpio_data *drvdata)
 {
-	drvdata->gpio_data = devm_gpiod_get(dev, "data", GPIOD_IN);
+	enum gpiod_flags gflags;
+
+	/* Enforce open drain, since this is required by the PS/2 bus. */
+	gflags = GPIOD_IN | GPIOD_FLAGS_BIT_OPEN_DRAIN;
+
+	drvdata->gpio_data = devm_gpiod_get(dev, "data", gflags);
 	if (IS_ERR(drvdata->gpio_data)) {
 		dev_err(dev, "failed to request data gpio: %ld",
 			PTR_ERR(drvdata->gpio_data));
 		return PTR_ERR(drvdata->gpio_data);
 	}
 
-	drvdata->gpio_clk = devm_gpiod_get(dev, "clk", GPIOD_IN);
+	drvdata->gpio_clk = devm_gpiod_get(dev, "clk", gflags);
 	if (IS_ERR(drvdata->gpio_clk)) {
 		dev_err(dev, "failed to request clock gpio: %ld",
 			PTR_ERR(drvdata->gpio_clk));
Signature · 1 line
2.35.1
maintainer Applied
#6 lore raw

Re: [PATCH v3 3/3] input: ps2-gpio: enforce GPIOs flag open drain

Quoted 6 lines · Danilo Krummrich

The PS/2 bus defines the data and clock line be open drain, therefore for both enforce the particular GPIO flags in the driver.

Without enforcing to flag at least the clock gpio as open drain we run into the following warning:

Quoted 6 lines
WARNING: CPU: 1 PID: 40 at drivers/gpio/gpiolib.c:3175 gpiochip_enable_irq+0x54/0x90

gpiochip_enable_irq() warns on a GPIO being configured as output while serving as IRQ source without being flagged as open drain.

Applied, thank you.

Signature · 1 line
Dmitry