diff mbox series

[2/2] dt-bindings: gpio: realtek: Add realtek,rtd-gpio bindings

Message ID 20231101025802.3744-3-tychang@realtek.com
State Changes Requested
Headers show
Series Add gpio driver support for Realtek DHC SoCs | expand

Checks

Context Check Description
robh/checkpatch success
robh/patch-applied success
robh/dtbs-check warning build log
robh/dt-meta-schema success

Commit Message

TY_Chang[張子逸] Nov. 1, 2023, 2:58 a.m. UTC
This patch adds the device tree bindings for the Realtek DHC RTD SoCs
GPIO controllers.

Signed-off-by: Tzuyi Chang <tychang@realtek.com>
---
 .../bindings/gpio/realtek,rtd-gpio.yaml       | 56 +++++++++++++++++++
 1 file changed, 56 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/gpio/realtek,rtd-gpio.yaml

Comments

Krzysztof Kozlowski Nov. 1, 2023, 7:13 a.m. UTC | #1
On 01/11/2023 03:58, Tzuyi Chang wrote:
> This patch adds the device tree bindings for the Realtek DHC RTD SoCs
> GPIO controllers.
> 

A nit, subject: drop second/last, redundant "bindings". The
"dt-bindings" prefix is already stating that these are bindings.

> Signed-off-by: Tzuyi Chang <tychang@realtek.com>
> ---
>  .../bindings/gpio/realtek,rtd-gpio.yaml       | 56 +++++++++++++++++++
>  1 file changed, 56 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/gpio/realtek,rtd-gpio.yaml

How does your binding come after the user?

> 
> diff --git a/Documentation/devicetree/bindings/gpio/realtek,rtd-gpio.yaml b/Documentation/devicetree/bindings/gpio/realtek,rtd-gpio.yaml
> new file mode 100644
> index 000000000000..6cab7ec50c88
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/gpio/realtek,rtd-gpio.yaml
> @@ -0,0 +1,56 @@
> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> +# Copyright 2023 Realtek Semiconductor Corporation
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/gpio/realtek,rtd-gpio.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Realtek DHC GPIO controller

What is DHC? Where is it explained in the binding?

> +
> +maintainers:
> +  - TY Chang <tychang@realtek.com>
> +
> +properties:
> +  compatible:
> +    enum:
> +      - realtek,rtd-gpio

What is "rtd"? Generic name? Drop. You cannot have generic compatibles.


> +      - realtek,rtd1295-misc-gpio
> +      - realtek,rtd1295-iso-gpio
> +      - realtek,rtd1395-iso-gpio
> +      - realtek,rtd1619-iso-gpio
> +
> +  reg:
> +    maxItems: 2

You need to describe the items instead.

> +
> +  interrupts:
> +    maxItems: 2

You need to describe the items instead.

> +
> +  gpio-ranges: true
> +
> +  gpio-controller: true
> +
> +  "#gpio-cells":
> +    const: 2
> +
> +required:
> +  - compatible
> +  - reg
> +  - interrupts
> +  - gpio-ranges
> +  - gpio-controller
> +  - "#gpio-cells"

Best regards,
Krzysztof
TY_Chang[張子逸] Nov. 2, 2023, 3:11 a.m. UTC | #2
Hi Krzysztof,

Thank you for the review.

>On 01/11/2023 03:58, Tzuyi Chang wrote:
>> This patch adds the device tree bindings for the Realtek DHC RTD SoCs
>> GPIO controllers.
>>
>
>A nit, subject: drop second/last, redundant "bindings". The "dt-bindings" prefix is
>already stating that these are bindings.
>
I will remove it.

>> Signed-off-by: Tzuyi Chang <tychang@realtek.com>
>> ---
>>  .../bindings/gpio/realtek,rtd-gpio.yaml       | 56 +++++++++++++++++++
>>  1 file changed, 56 insertions(+)
>>  create mode 100644
>> Documentation/devicetree/bindings/gpio/realtek,rtd-gpio.yaml
>
>How does your binding come after the user?
>

I wil move the binding to the first patch.

>>
>> diff --git
>> a/Documentation/devicetree/bindings/gpio/realtek,rtd-gpio.yaml
>> b/Documentation/devicetree/bindings/gpio/realtek,rtd-gpio.yaml
>> new file mode 100644
>> index 000000000000..6cab7ec50c88
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/gpio/realtek,rtd-gpio.yaml
>> @@ -0,0 +1,56 @@
>> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause) # Copyright 2023
>> +Realtek Semiconductor Corporation %YAML 1.2
>> +---
>> +$id: http://devicetree.org/schemas/gpio/realtek,rtd-gpio.yaml#
>> +$schema: http://devicetree.org/meta-schemas/core.yaml#
>> +
>> +title: Realtek DHC GPIO controller
>
>What is DHC? Where is it explained in the binding?
>

This is the abbreviation of "Digital Home Center". I will add the description to explain it.

>> +
>> +maintainers:
>> +  - TY Chang <tychang@realtek.com>
>> +
>> +properties:
>> +  compatible:
>> +    enum:
>> +      - realtek,rtd-gpio
>
>What is "rtd"? Generic name? Drop. You cannot have generic compatibles.
>

This is a generic name for the others SoCs without the specific compatible.
I will fix it.

>
>> +      - realtek,rtd1295-misc-gpio
>> +      - realtek,rtd1295-iso-gpio
>> +      - realtek,rtd1395-iso-gpio
>> +      - realtek,rtd1619-iso-gpio
>> +
>> +  reg:
>> +    maxItems: 2
>
>You need to describe the items instead.
>

I will add the description.

>> +
>> +  interrupts:
>> +    maxItems: 2
>
>You need to describe the items instead.
>

I will add the description.

>> +
>> +  gpio-ranges: true
>> +
>> +  gpio-controller: true
>> +
>> +  "#gpio-cells":
>> +    const: 2
>> +
>> +required:
>> +  - compatible
>> +  - reg
>> +  - interrupts
>> +  - gpio-ranges
>> +  - gpio-controller
>> +  - "#gpio-cells"
>
>Best regards,
>Krzysztof


Thanks,
Tzuyi Chang
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/gpio/realtek,rtd-gpio.yaml b/Documentation/devicetree/bindings/gpio/realtek,rtd-gpio.yaml
new file mode 100644
index 000000000000..6cab7ec50c88
--- /dev/null
+++ b/Documentation/devicetree/bindings/gpio/realtek,rtd-gpio.yaml
@@ -0,0 +1,56 @@ 
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+# Copyright 2023 Realtek Semiconductor Corporation
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/gpio/realtek,rtd-gpio.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Realtek DHC GPIO controller
+
+maintainers:
+  - TY Chang <tychang@realtek.com>
+
+properties:
+  compatible:
+    enum:
+      - realtek,rtd-gpio
+      - realtek,rtd1295-misc-gpio
+      - realtek,rtd1295-iso-gpio
+      - realtek,rtd1395-iso-gpio
+      - realtek,rtd1619-iso-gpio
+
+  reg:
+    maxItems: 2
+
+  interrupts:
+    maxItems: 2
+
+  gpio-ranges: true
+
+  gpio-controller: true
+
+  "#gpio-cells":
+    const: 2
+
+required:
+  - compatible
+  - reg
+  - interrupts
+  - gpio-ranges
+  - gpio-controller
+  - "#gpio-cells"
+
+additionalProperties: false
+
+examples:
+  - |
+    gpio@100 {
+      compatible = "realtek,rtd-gpio";
+      reg = <0x100 0x100>,
+            <0x000 0x0b0>;
+      interrupt-parent = <&iso_irq_mux>;
+      interrupts = <19>, <20>;
+      gpio-ranges = <&pinctrl 0 0 82>;
+      gpio-controller;
+      #gpio-cells = <2>;
+    };