diff mbox series

[v4,17/18] dt: bindings: net: add microchip,wilc1000,spi.yaml

Message ID 20200302163414.4342-18-ajay.kathat@microchip.com
State Changes Requested
Headers show
Series wilc1000: move out of staging | expand

Checks

Context Check Description
robh/dt-meta-schema success
robh/checkpatch warning "total: 0 errors, 1 warnings, 61 lines checked"
robh/dt-meta-schema success
robh/dt-meta-schema success
robh/checkpatch warning "total: 0 errors, 1 warnings, 61 lines checked"
robh/checkpatch warning "total: 0 errors, 1 warnings, 61 lines checked"

Commit Message

Ajay.Kathat@microchip.com March 2, 2020, 4:34 p.m. UTC
From: Ajay Singh <ajay.kathat@microchip.com>

Moved '/drivers/staging/wilc1000//microchip,wilc1000,spi.yaml' to
'Documentation/devicetree/bindings/net/wireless/microchip,wilc1000,spi.yaml'.

Signed-off-by: Ajay Singh <ajay.kathat@microchip.com>
---
 .../net/wireless/microchip,wilc1000,spi.yaml  | 61 +++++++++++++++++++
 1 file changed, 61 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/net/wireless/microchip,wilc1000,spi.yaml

Comments

Rob Herring March 3, 2020, 2:02 a.m. UTC | #1
On Mon, Mar 02, 2020 at 04:34:40PM +0000, Ajay.Kathat@microchip.com wrote:
> From: Ajay Singh <ajay.kathat@microchip.com>
> 
> Moved '/drivers/staging/wilc1000//microchip,wilc1000,spi.yaml' to
> 'Documentation/devicetree/bindings/net/wireless/microchip,wilc1000,spi.yaml'.

Not a useful changelog.

I think this should be combined with the SDIO version. Details below.

> 
> Signed-off-by: Ajay Singh <ajay.kathat@microchip.com>
> ---
>  .../net/wireless/microchip,wilc1000,spi.yaml  | 61 +++++++++++++++++++
>  1 file changed, 61 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/net/wireless/microchip,wilc1000,spi.yaml
> 
> diff --git a/Documentation/devicetree/bindings/net/wireless/microchip,wilc1000,spi.yaml b/Documentation/devicetree/bindings/net/wireless/microchip,wilc1000,spi.yaml
> new file mode 100644
> index 000000000000..cc8ed64ce627
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/net/wireless/microchip,wilc1000,spi.yaml
> @@ -0,0 +1,61 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/net/wireless/microchip,wilc1000,spi.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Microchip WILC wireless SPI devicetree bindings
> +
> +maintainers:
> +  - Adham Abozaeid <adham.abozaeid@microchip.com>
> +  - Ajay Singh <ajay.kathat@microchip.com>
> +
> +description:
> +  The wilc1000 chips can be connected via SPI. This document describes
> +  the binding for the SPI connected module.
> +
> +properties:
> +  compatible:
> +    const: microchip,wilc1000-spi

You can drop '-spi' (and '-sdio'). They don't need to be different 
because they already sit on different buses.

> +
> +  spi-max-frequency:
> +    description: Maximum SPI clocking speed of device in Hz.
> +    maxItems: 1
> +
> +  reg:
> +    description: Chip select address of device.
> +    maxItems: 1
> +
> +  irq-gpios:
> +    description: The GPIO phandle connect to a host IRQ.
> +    maxItems: 1
> +
> +  clocks:
> +    description: phandle to the clock connected on rtc clock line.
> +    maxItems: 1
> +
> +required:
> +  - compatible
> +  - spi-max-frequency

This should not be required.

> +  - reg
> +  - irq-gpios
> +
> +examples:
> +  - |
> +    spi1: spi@fc018000 {
> +      #address-cells = <1>;
> +      #size-cells = <0>;
> +      cs-gpios = <&pioB 21 0>;
> +      status = "okay";
> +      wilc_spi@0 {
> +        compatible = "microchip,wilc1000-spi";
> +        spi-max-frequency = <48000000>;
> +        reg = <0>;
> +        irq-gpios = <&pioC 27 0>;
> +        clocks = <&pck1>;
> +        clock-names = "rtc_clk";

Not documented. '_clk' is redundant.

> +        assigned-clocks = <&pck1>;
> +        assigned-clock-rates = <32768>;

Not documented.

> +        status = "okay";
> +      };
> +    };
> -- 
> 2.24.0
Ajay.Kathat@microchip.com March 3, 2020, 12:45 p.m. UTC | #2
On 03/03/20 7:32 am, Rob Herring wrote:
> 
> On Mon, Mar 02, 2020 at 04:34:40PM +0000, Ajay.Kathat@microchip.com wrote:
>> From: Ajay Singh <ajay.kathat@microchip.com>
>>
>> Moved '/drivers/staging/wilc1000//microchip,wilc1000,spi.yaml' to
>> 'Documentation/devicetree/bindings/net/wireless/microchip,wilc1000,spi.yaml'.
> 
> Not a useful changelog.
> 

Sure. I will update the changelog.

> I think this should be combined with the SDIO version. Details below.
> 
>>
>> Signed-off-by: Ajay Singh <ajay.kathat@microchip.com>
>> ---
>>  .../net/wireless/microchip,wilc1000,spi.yaml  | 61 +++++++++++++++++++
>>  1 file changed, 61 insertions(+)
>>  create mode 100644 Documentation/devicetree/bindings/net/wireless/microchip,wilc1000,spi.yaml
>>
>> diff --git a/Documentation/devicetree/bindings/net/wireless/microchip,wilc1000,spi.yaml b/Documentation/devicetree/bindings/net/wireless/microchip,wilc1000,spi.yaml
>> new file mode 100644
>> index 000000000000..cc8ed64ce627
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/net/wireless/microchip,wilc1000,spi.yaml
>> @@ -0,0 +1,61 @@
>> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
>> +%YAML 1.2
>> +---
>> +$id: http://devicetree.org/schemas/net/wireless/microchip,wilc1000,spi.yaml#
>> +$schema: http://devicetree.org/meta-schemas/core.yaml#
>> +
>> +title: Microchip WILC wireless SPI devicetree bindings
>> +
>> +maintainers:
>> +  - Adham Abozaeid <adham.abozaeid@microchip.com>
>> +  - Ajay Singh <ajay.kathat@microchip.com>
>> +
>> +description:
>> +  The wilc1000 chips can be connected via SPI. This document describes
>> +  the binding for the SPI connected module.
>> +
>> +properties:
>> +  compatible:
>> +    const: microchip,wilc1000-spi
> 
> You can drop '-spi' (and '-sdio'). They don't need to be different
> because they already sit on different buses.
> 

In that case, we should use only a single DT binding documentation and
keep both example inside the same file i.e We will have single
properties descriptions with 2 examples(sdio/spi) in a single DT binding
document. Is my understanding correct?

>> +
>> +  spi-max-frequency:
>> +    description: Maximum SPI clocking speed of device in Hz.
>> +    maxItems: 1
>> +
>> +  reg:
>> +    description: Chip select address of device.
>> +    maxItems: 1
>> +
>> +  irq-gpios:
>> +    description: The GPIO phandle connect to a host IRQ.
>> +    maxItems: 1
>> +
>> +  clocks:
>> +    description: phandle to the clock connected on rtc clock line.
>> +    maxItems: 1
>> +
>> +required:
>> +  - compatible
>> +  - spi-max-frequency
> 
> This should not be required.
> 

Ok. I will drop this.

>> +  - reg
>> +  - irq-gpios
>> +
>> +examples:
>> +  - |
>> +    spi1: spi@fc018000 {
>> +      #address-cells = <1>;
>> +      #size-cells = <0>;
>> +      cs-gpios = <&pioB 21 0>;
>> +      status = "okay";
>> +      wilc_spi@0 {
>> +        compatible = "microchip,wilc1000-spi";
>> +        spi-max-frequency = <48000000>;
>> +        reg = <0>;
>> +        irq-gpios = <&pioC 27 0>;
>> +        clocks = <&pck1>;
>> +        clock-names = "rtc_clk";
> 
> Not documented. '_clk' is redundant.
> 

Ok. I will update the clock-names and add the description.

>> +        assigned-clocks = <&pck1>;
>> +        assigned-clock-rates = <32768>;
> 
> Not documented.
> 

Ok. I will add the description.


Regards,
Ajay
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/net/wireless/microchip,wilc1000,spi.yaml b/Documentation/devicetree/bindings/net/wireless/microchip,wilc1000,spi.yaml
new file mode 100644
index 000000000000..cc8ed64ce627
--- /dev/null
+++ b/Documentation/devicetree/bindings/net/wireless/microchip,wilc1000,spi.yaml
@@ -0,0 +1,61 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/net/wireless/microchip,wilc1000,spi.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Microchip WILC wireless SPI devicetree bindings
+
+maintainers:
+  - Adham Abozaeid <adham.abozaeid@microchip.com>
+  - Ajay Singh <ajay.kathat@microchip.com>
+
+description:
+  The wilc1000 chips can be connected via SPI. This document describes
+  the binding for the SPI connected module.
+
+properties:
+  compatible:
+    const: microchip,wilc1000-spi
+
+  spi-max-frequency:
+    description: Maximum SPI clocking speed of device in Hz.
+    maxItems: 1
+
+  reg:
+    description: Chip select address of device.
+    maxItems: 1
+
+  irq-gpios:
+    description: The GPIO phandle connect to a host IRQ.
+    maxItems: 1
+
+  clocks:
+    description: phandle to the clock connected on rtc clock line.
+    maxItems: 1
+
+required:
+  - compatible
+  - spi-max-frequency
+  - reg
+  - irq-gpios
+
+examples:
+  - |
+    spi1: spi@fc018000 {
+      #address-cells = <1>;
+      #size-cells = <0>;
+      cs-gpios = <&pioB 21 0>;
+      status = "okay";
+      wilc_spi@0 {
+        compatible = "microchip,wilc1000-spi";
+        spi-max-frequency = <48000000>;
+        reg = <0>;
+        irq-gpios = <&pioC 27 0>;
+        clocks = <&pck1>;
+        clock-names = "rtc_clk";
+        assigned-clocks = <&pck1>;
+        assigned-clock-rates = <32768>;
+        status = "okay";
+      };
+    };