staging: wilc1000: use YAML schemas for DT binding documentation

Use YAML schemas for wilc1000 DT binding documentations. Currently, the
files are present in '/drivers/staging/wilc1000/' but these will be
moved to '/Documentation/devicetree/bindings/net/wireless/' later once
the driver move out-of-staging.

Signed-off-by: Ajay Singh <ajay.kathat@microchip.com>
Link: https://lore.kernel.org/r/20200221123817.16643-1-ajay.kathat@microchip.com
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
This commit is contained in:
Ajay Singh 2020-02-21 12:38:29 +00:00 committed by Greg Kroah-Hartman
parent 6c411581ca
commit 31e234948e
4 changed files with 129 additions and 72 deletions

View File

@ -1,38 +0,0 @@
* Microchip WILC wireless SDIO device
The wilc1000 chips can be connected via SDIO. The node is used to specifiy
child node to the SDIO controller that connects the device to the system.
Required properties:
- compatible : Should be "microchip,wilc1000-spi"
- irq-gpios : Connect to a host IRQ
- reg : Slot ID used in the controller
Optional:
- bus-width : Number of data lines wired up the slot. Default 1 bit.
- rtc_clk : Clock connected on the rtc clock line. Must be assigned
a frequency with assigned-clocks property, and must be
connected to a clock provider.
Examples:
mmc1: mmc@fc000000 {
pinctrl-names = "default";
pinctrl-0 = <&pinctrl_mmc1_clk_cmd_dat0 &pinctrl_mmc1_dat1_3>;
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>;
clocks = <&pck1>;
clock-names = "rtc_clk";
assigned-clocks = <&pck1>;
assigned-clock-rates = <32768>;
status = "okay";
reg = <0>;
bus-width = <4>;
}
};
}

View File

@ -0,0 +1,68 @@
# 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#
$schema: http://devicetree.org/meta-schemas/core.yaml#
title: Microchip WILC wireless SDIO 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.
properties:
compatible:
const: microchip,wilc1000-sdio
irq-gpios:
description: The GPIO phandle connect to a host IRQ.
maxItems: 1
reg:
description: Slot ID used in the controller.
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
required:
- compatible
- irq-gpios
- reg
examples:
- |
mmc1: mmc@fc000000 {
#address-cells = <1>;
#size-cells = <0>;
pinctrl-names = "default";
pinctrl-0 = <&pinctrl_mmc1_clk_cmd_dat0 &pinctrl_mmc1_dat1_3>;
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>;
reg = <0>;
clocks = <&pck1>;
clock-names = "rtc_clk";
assigned-clocks = <&pck1>;
assigned-clock-rates = <32768>;
status = "okay";
bus-width = <4>;
};
};

View File

@ -1,34 +0,0 @@
* Microchip WILC wireless SPI device
The wilc1000 chips can be connected via SPI. This document describes
the binding for the SPI connected module.
Required properties:
- compatible : Should be "microchip,wilc1000-spi"
- spi-max-frequency : Maximum SPI clocking speed of device in Hz
- reg : Chip select address of device
- irq-gpios : Connect to a host IRQ
Optional:
- rtc_clk : Clock connected on the rtc clock line. Must be assigned
a frequency with assigned-clocks property, and must be
connected to a clock provider.
Examples:
spi1: spi@fc018000 {
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";
};
};

View File

@ -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";
};
};