diff mbox series

[1/2] dt-bindings: gpio: add adg1414

Message ID 20240121103505.26475-2-kimseer.paller@analog.com
State New
Headers show
Series ADG1414 for review | expand

Commit Message

Kim Seer Paller Jan. 21, 2024, 10:35 a.m. UTC 
The ADG1414 is a 9.5 Ω RON ±15 V/+12 V/±5 V iCMOS Serially-Controlled
Octal SPST Switches

Signed-off-by: Kim Seer Paller <kimseer.paller@analog.com>
---
 .../bindings/gpio/gpio-adg1414.yaml           | 66 +++++++++++++++++++
 MAINTAINERS                                   |  6 ++
 2 files changed, 72 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/gpio/gpio-adg1414.yaml

Comments

Krzysztof Kozlowski Jan. 22, 2024, 12:40 p.m. UTC | #1 
On 21/01/2024 11:35, Kim Seer Paller wrote:
> The ADG1414 is a 9.5 Ω RON ±15 V/+12 V/±5 V iCMOS Serially-Controlled
> Octal SPST Switches
> 
> Signed-off-by: Kim Seer Paller <kimseer.paller@analog.com>
> ---
>  .../bindings/gpio/gpio-adg1414.yaml           | 66 +++++++++++++++++++
>  MAINTAINERS                                   |  6 ++
>  2 files changed, 72 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/gpio/gpio-adg1414.yaml
> 
> diff --git a/Documentation/devicetree/bindings/gpio/gpio-adg1414.yaml b/Documentation/devicetree/bindings/gpio/gpio-adg1414.yaml
> new file mode 100644
> index 000000000..24a51e79f
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/gpio/gpio-adg1414.yaml

Filename like compatible.


> @@ -0,0 +1,66 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/gpio/gpio-adg1414.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: ADG1414 SPST Switch Driver

"Driver" as Linux driver or some hardware driver?

> +
> +maintainers:
> +  - Kim Seer Paller <kimseer.paller@analog.com>
> +
> +description:
> +  The ADG1414 is a 9.5 Ω RON ±15 V/+12 V/±5 V iCMOS serially-controlled
> +  octal SPST switches.
> +
> +properties:
> +  compatible:
> +    enum:
> +      - adi,adg1414
> +
> +  reg:
> +    maxItems: 1
> +
> +  gpio-controller: true
> +
> +  '#gpio-cells':
> +    const: 2
> +
> +  spi-cpha: true
> +
> +  reset-gpios:
> +    description: GPIO specifier that resets the device.

Drop description, it's obvious. You could instead say something useful,
like name of pin.

> +    maxItems: 1
> +
> +  '#daisy-chained-devices':
> +    description: The number of daisy-chained devices.
> +    default: 1
> +    minimum: 1
> +    maximum: 4

This needs to be added to dtschema or at least its type should be here.

> +
> +required:
> +  - compatible
> +  - reg
> +  - spi-cpha
> +
> +allOf:
> +  - $ref: /schemas/spi/spi-peripheral-props.yaml#
> +
> +unevaluatedProperties: false
> +


Best regards,
Krzysztof
Krzysztof Kozlowski Jan. 23, 2024, 9:57 a.m. UTC | #2 
On 23/01/2024 10:55, Paller, Kim Seer wrote:
> Hi Krzysztof,
> 
>> -----Original Message-----
>> From: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
>> Sent: Monday, January 22, 2024 8:40 PM
>> To: Paller, Kim Seer <KimSeer.Paller@analog.com>; linux-gpio@vger.kernel.org;
>> devicetree@vger.kernel.org; linux-kernel@vger.kernel.org
>> Cc: Linus Walleij <linus.walleij@linaro.org>; Bartosz Golaszewski
>> <brgl@bgdev.pl>; Rob Herring <robh+dt@kernel.org>; Krzysztof Kozlowski
>> <krzysztof.kozlowski+dt@linaro.org>; Conor Dooley <conor+dt@kernel.org>
>> Subject: Re: [PATCH 1/2] dt-bindings: gpio: add adg1414
>>
>> [External]
>>
>> On 21/01/2024 11:35, Kim Seer Paller wrote:
>>> The ADG1414 is a 9.5 Ω RON ±15 V/+12 V/±5 V iCMOS Serially-Controlled
>>> Octal SPST Switches
>>>
>>> Signed-off-by: Kim Seer Paller <kimseer.paller@analog.com>
>>> ---
>>>  .../bindings/gpio/gpio-adg1414.yaml           | 66 +++++++++++++++++++
>>>  MAINTAINERS                                   |  6 ++
>>>  2 files changed, 72 insertions(+)
>>>  create mode 100644
>>> Documentation/devicetree/bindings/gpio/gpio-adg1414.yaml
>>>
>>> diff --git a/Documentation/devicetree/bindings/gpio/gpio-adg1414.yaml
>>> b/Documentation/devicetree/bindings/gpio/gpio-adg1414.yaml
>>> new file mode 100644
>>> index 000000000..24a51e79f
>>> --- /dev/null
>>> +++ b/Documentation/devicetree/bindings/gpio/gpio-adg1414.yaml
>>
>> Filename like compatible.
> 
> I would like to clarify, is it changing the filename from gpio-adg1414.yaml
> to adg1414.yaml? 

No, because you miss vendor prefix. I doubt that it is your compatible...

> 
>>> @@ -0,0 +1,66 @@
>>> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) %YAML 1.2
>>> +---
>>> +$id:
>>> +https://urldefense.com/v3/__http://devicetree.org/schemas/gpio/gpio-a
>>> +dg1414.yaml*__;Iw!!A3Ni8CS0y2Y!_Q0zRB8J-
>> inWIIybgOjtThU0toJeUzqaT9Tveg
>>> +XTjvPWiCTh4IAJ5DkNepFdfhXXfxXLnB2wSR9_LgPnvVnFqw2bDuvBI8g$
>>> +$schema:
>>> +https://urldefense.com/v3/__http://devicetree.org/meta-schemas/core.y
>>> +aml*__;Iw!!A3Ni8CS0y2Y!_Q0zRB8J-
>> inWIIybgOjtThU0toJeUzqaT9TvegXTjvPWiC
>>> +Th4IAJ5DkNepFdfhXXfxXLnB2wSR9_LgPnvVnFqw2bEIZ1PG4$
>>> +
>>> +title: ADG1414 SPST Switch Driver
>>
>> "Driver" as Linux driver or some hardware driver?
> 
> Linux device driver. It seems I overlooked this one, it should be ADG1414 Octal SPST Switches

Then please drop it and double check if your description also has it.
The title and description should describe hardware.

Best regards,
Krzysztof
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/gpio/gpio-adg1414.yaml b/Documentation/devicetree/bindings/gpio/gpio-adg1414.yaml
new file mode 100644
index 000000000..24a51e79f
--- /dev/null
+++ b/Documentation/devicetree/bindings/gpio/gpio-adg1414.yaml
@@ -0,0 +1,66 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/gpio/gpio-adg1414.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: ADG1414 SPST Switch Driver
+
+maintainers:
+  - Kim Seer Paller <kimseer.paller@analog.com>
+
+description:
+  The ADG1414 is a 9.5 Ω RON ±15 V/+12 V/±5 V iCMOS serially-controlled
+  octal SPST switches.
+
+properties:
+  compatible:
+    enum:
+      - adi,adg1414
+
+  reg:
+    maxItems: 1
+
+  gpio-controller: true
+
+  '#gpio-cells':
+    const: 2
+
+  spi-cpha: true
+
+  reset-gpios:
+    description: GPIO specifier that resets the device.
+    maxItems: 1
+
+  '#daisy-chained-devices':
+    description: The number of daisy-chained devices.
+    default: 1
+    minimum: 1
+    maximum: 4
+
+required:
+  - compatible
+  - reg
+  - spi-cpha
+
+allOf:
+  - $ref: /schemas/spi/spi-peripheral-props.yaml#
+
+unevaluatedProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/gpio/gpio.h>
+    spi {
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+        gpio@0 {
+            compatible = "adi,adg1414";
+            reg = <0>;
+            spi-max-frequency = <1000000>;
+            spi-cpha;
+            reset-gpios = <&gpio 17 GPIO_ACTIVE_HIGH>;
+        };
+    };
+...
diff --git a/MAINTAINERS b/MAINTAINERS
index 8d1052fa6..526145e69 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -461,6 +461,12 @@  W:	https://ez.analog.com/linux-software-drivers
 F:	Documentation/devicetree/bindings/net/ieee802154/adf7242.txt
 F:	drivers/net/ieee802154/adf7242.c
 
+ADG1414 SPST Switch Driver
+M:	Kim Seer Paller <kimseer.paller@analog.com>
+S:	Supported
+W:	https://ez.analog.com/linux-software-drivers
+F:	Documentation/devicetree/bindings/gpio/gpio-adg1414.yaml
+
 ADM1025 HARDWARE MONITOR DRIVER
 M:	Jean Delvare <jdelvare@suse.com>
 L:	linux-hwmon@vger.kernel.org