Commit 1693a2fa authored by Ajay Singh's avatar Ajay Singh Committed by Greg Kroah-Hartman
Browse files

staging: wilc1000: updated DT binding documentation 

Merged the DT binding documentation of SDIO and SPI into a single file.
Removed documentation for some of the properties which are not required
and handled review comments received in [1] & [2].

[1]. https://lore.kernel.org/linux-wireless/20200303020230.GA15543@bogus
[2]. https://lore.kernel.org/linux-wireless/20200303015558.GA6876@bogus



Signed-off-by: default avatarAjay Singh <ajay.kathat@microchip.com>
Link: https://lore.kernel.org/r/20200307085523.7320-4-ajay.kathat@microchip.com


Signed-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent 9aa4e8de

drivers/staging/wilc1000/microchip,wilc1000,spi.yaml

deleted100644 → 0
+0 −61
Original line number Diff line number Diff line 
# 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";

      };

    };

drivers/staging/wilc1000/microchip,wilc1000,sdio.yaml→drivers/staging/wilc1000/microchip,wilc1000.yaml

+72 −0
Original line number Diff line number Diff line 
# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)

%YAML 1.2

---

$id: http://devicetree.org/schemas/net/wireless/microchip,wilc1000,sdio.yaml#

$id: http://devicetree.org/schemas/net/wireless/microchip,wilc1000.yaml#

$schema: http://devicetree.org/meta-schemas/core.yaml#



title: Microchip WILC wireless SDIO devicetree bindings

title: Microchip WILC wireless devicetree bindings



maintainers:

  - Adham Abozaeid <adham.abozaeid@microchip.com>

  - Ajay Singh <ajay.kathat@microchip.com>



description:

  The wilc1000 chips can be connected via SDIO. The node is used to

  specify child node to the SDIO controller that connects the device

  to the system.

  The wilc1000 chips can be connected via SPI or SDIO. This document

  describes the binding to connect wilc devices.



properties:

  compatible:

    const: microchip,wilc1000-sdio

    const: microchip,wilc1000



  irq-gpios:

    description: The GPIO phandle connect to a host IRQ.

    maxItems: 1

  spi-max-frequency: true



  reg:

    description: Slot ID used in the controller.

  interrupts:

    maxItems: 1



  clocks:

    description: phandle to the clock connected on rtc clock line.

    maxItems: 1



  bus-width:

    description: The number of data lines wired up the slot.

    allOf:

      - $ref: /schemas/types.yaml#/definitions/uint32

      - enum: [1, 4, 8]

      - default: 1

  clock-names:

    const: rtc



required:

  - compatible

  - irq-gpios

  - reg

  - interrupts



examples:

  - |

    spi1: spi@fc018000 {

      #address-cells = <1>;

      #size-cells = <0>;

      cs-gpios = <&pioB 21 0>;

      wifi@0 {

        compatible = "microchip,wilc1000";

        spi-max-frequency = <48000000>;

        reg = <0>;

        interrupt-parent = <&pioC>;

        interrupts = <27 0>;

        clocks = <&pck1>;

        clock-names = "rtc";

      };

    };



  - |

    mmc1: mmc@fc000000 {

      #address-cells = <1>;
@@ -53,16 +60,13 @@ examples: 
      non-removable;

      vmmc-supply = <&vcc_mmc1_reg>;

      vqmmc-supply = <&vcc_3v3_reg>;

      status = "okay";

      wilc_sdio@0 {

        compatible = "microchip,wilc1000-sdio";

          irq-gpios = <&pioC 27 0>;

      bus-width = <4>;

      wifi@0 {

        compatible = "microchip,wilc1000";

        reg = <0>;

        interrupt-parent = <&pioC>;

        interrupts = <27 0>;

        clocks = <&pck1>;

          clock-names = "rtc_clk";

          assigned-clocks = <&pck1>;

          assigned-clock-rates = <32768>;

          status = "okay";

          bus-width = <4>;

        clock-names = "rtc";

      };

    };