| Message ID | 20220111171424.862764-3-Jerome.Pouiller@silabs.com (mailing list archive) |
|---|---|
| State | Not Applicable |
| Delegated to: | Kalle Valo |
| Headers | show |
| Series | wfx: get out from the staging area | expand |
On Tue, 11 Jan 2022 18:14:02 +0100, Jerome Pouiller wrote: > From: Jérôme Pouiller <jerome.pouiller@silabs.com> > > Prepare the inclusion of the wfx driver in the kernel. > > Signed-off-by: Jérôme Pouiller <jerome.pouiller@silabs.com> > --- > .../bindings/net/wireless/silabs,wfx.yaml | 138 ++++++++++++++++++ > 1 file changed, 138 insertions(+) > create mode 100644 Documentation/devicetree/bindings/net/wireless/silabs,wfx.yaml > My bot found errors running 'make DT_CHECKER_FLAGS=-m dt_binding_check' on your patch (DT_CHECKER_FLAGS is new in v5.13): yamllint warnings/errors: dtschema/dtc warnings/errors: /builds/robherring/linux-dt-review/Documentation/devicetree/bindings/net/wireless/silabs,wfx.example.dt.yaml: wifi@0: compatible: 'anyOf' conditional failed, one must be fixed: ['silabs,brd4001a', 'silabs,wf200'] is too long Additional items are not allowed ('silabs,wf200' was unexpected) 'silabs,wf200' was expected 'silabs,brd8022a' was expected 'silabs,brd8023a' was expected From schema: /builds/robherring/linux-dt-review/Documentation/devicetree/bindings/net/wireless/silabs,wfx.yaml /builds/robherring/linux-dt-review/Documentation/devicetree/bindings/net/wireless/silabs,wfx.example.dt.yaml: wifi@1: compatible: 'anyOf' conditional failed, one must be fixed: ['silabs,brd8022a', 'silabs,wf200'] is too long Additional items are not allowed ('silabs,wf200' was unexpected) 'silabs,wf200' was expected 'silabs,brd4001a' was expected 'silabs,brd8023a' was expected From schema: /builds/robherring/linux-dt-review/Documentation/devicetree/bindings/net/wireless/silabs,wfx.yaml doc reference errors (make refcheckdocs): See https://patchwork.ozlabs.org/patch/1578580 This check can fail if there are any dependencies. The base for a patch series is generally the most recent rc1. If you already ran 'make dt_binding_check' and didn't see the above error(s), then make sure 'yamllint' is installed and dt-schema is up to date: pip3 install dtschema --upgrade Please check and re-submit.
On Tue, Jan 11, 2022 at 06:14:02PM +0100, Jerome Pouiller wrote: > From: Jérôme Pouiller <jerome.pouiller@silabs.com> > > Prepare the inclusion of the wfx driver in the kernel. > > Signed-off-by: Jérôme Pouiller <jerome.pouiller@silabs.com> > --- > .../bindings/net/wireless/silabs,wfx.yaml | 138 ++++++++++++++++++ > 1 file changed, 138 insertions(+) > create mode 100644 Documentation/devicetree/bindings/net/wireless/silabs,wfx.yaml > > diff --git a/Documentation/devicetree/bindings/net/wireless/silabs,wfx.yaml b/Documentation/devicetree/bindings/net/wireless/silabs,wfx.yaml > new file mode 100644 > index 000000000000..d12f262868cf > --- /dev/null > +++ b/Documentation/devicetree/bindings/net/wireless/silabs,wfx.yaml > @@ -0,0 +1,138 @@ > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) > +# Copyright (c) 2020, Silicon Laboratories, Inc. > +%YAML 1.2 > +--- > + > +$id: http://devicetree.org/schemas/net/wireless/silabs,wfx.yaml# > +$schema: http://devicetree.org/meta-schemas/core.yaml# > + > +title: Silicon Labs WFxxx devicetree bindings > + > +maintainers: > + - Jérôme Pouiller <jerome.pouiller@silabs.com> > + > +description: > > + Support for the Wifi chip WFxxx from Silicon Labs. Currently, the only device > + from the WFxxx series is the WF200 described here: > + https://www.silabs.com/documents/public/data-sheets/wf200-datasheet.pdf > + > + The WF200 can be connected via SPI or via SDIO. > + > + For SDIO: > + > + Declaring the WFxxx chip in device tree is mandatory (usually, the VID/PID is > + sufficient for the SDIO devices). > + > + It is recommended to declare a mmc-pwrseq on SDIO host above WFx. Without > + it, you may encounter issues during reboot. The mmc-pwrseq should be > + compatible with mmc-pwrseq-simple. Please consult > + Documentation/devicetree/bindings/mmc/mmc-pwrseq-simple.yaml for more > + information. > + > + For SPI: > + > + In add of the properties below, please consult > + Documentation/devicetree/bindings/spi/spi-controller.yaml for optional SPI > + related properties. > + > +properties: > + compatible: > + anyOf: > + - const: silabs,wf200 # Chip alone without antenna > + - const: silabs,brd4001a # WGM160P Evaluation Board > + - const: silabs,brd8022a # WF200 Evaluation Board > + - const: silabs,brd8023a # WFM200 Evaluation Board This still defines that compatible is a single entry. You need something like: items: - enum: - silabs,brd4001a - silabs,brd8022a - silabs,brd8023a - const: silabs,wf200 You need a separate 'items' list for different number of compatible entries (e.g. if a single string is valid) and that is when you need to use 'oneOf'. Plenty of examples in the tree. > + > + reg: > + description: > + When used on SDIO bus, <reg> must be set to 1. When used on SPI bus, it is > + the chip select address of the device as defined in the SPI devices > + bindings. > + maxItems: 1 > + > + spi-max-frequency: true > + > + interrupts: > + description: The interrupt line. Triggers IRQ_TYPE_LEVEL_HIGH and > + IRQ_TYPE_EDGE_RISING are both supported by the chip and the driver. When Unless there is a mode you can configure, supporting both is wrong even though edge will mostly work for a device that is really level. What a driver supports is not relevant to the binding. > + SPI is used, this property is required. When SDIO is used, the "in-band" > + interrupt provided by the SDIO bus is used unless an interrupt is defined > + in the Device Tree. > + maxItems: 1 > + > + reset-gpios: > + description: (SPI only) Phandle of gpio that will be used to reset chip > + during probe. Without this property, you may encounter issues with warm > + boot. (For legacy purpose, the gpio in inverted when compatible == > + "silabs,wfx-spi") What legacy? This is a new binding. > + > + For SDIO, the reset gpio should declared using a mmc-pwrseq. > + maxItems: 1 > + > + wakeup-gpios: > + description: Phandle of gpio that will be used to wake-up chip. Without this > + property, driver will disable most of power saving features. > + maxItems: 1 > + > + silabs,antenna-config-file: > + $ref: /schemas/types.yaml#/definitions/string > + description: Use an alternative file for antenna configuration (aka > + "Platform Data Set" in Silabs jargon). Default depends of "compatible" > + string. For "silabs,wf200", the default is 'wf200.pds'. > + > + local-mac-address: true > + > + mac-address: true > + > +additionalProperties: false > + > +required: > + - compatible > + - reg > + > +examples: > + - | > + #include <dt-bindings/gpio/gpio.h> > + #include <dt-bindings/interrupt-controller/irq.h> > + > + spi0 { spi { > + #address-cells = <1>; > + #size-cells = <0>; > + > + wifi@0 { > + compatible = "silabs,brd4001a", "silabs,wf200"; > + pinctrl-names = "default"; > + pinctrl-0 = <&wfx_irq &wfx_gpios>; > + reg = <0>; > + interrupts-extended = <&gpio 16 IRQ_TYPE_EDGE_RISING>; > + wakeup-gpios = <&gpio 12 GPIO_ACTIVE_HIGH>; > + reset-gpios = <&gpio 13 GPIO_ACTIVE_LOW>; > + spi-max-frequency = <42000000>; > + }; > + }; > + > + - | > + #include <dt-bindings/gpio/gpio.h> > + #include <dt-bindings/interrupt-controller/irq.h> > + > + wfx_pwrseq: wfx_pwrseq { > + compatible = "mmc-pwrseq-simple"; > + pinctrl-names = "default"; > + pinctrl-0 = <&wfx_reset>; > + reset-gpios = <&gpio 13 GPIO_ACTIVE_LOW>; > + }; > + > + mmc0 { mmc { > + mmc-pwrseq = <&wfx_pwrseq>; > + #address-cells = <1>; > + #size-cells = <0>; > + > + wifi@1 { > + compatible = "silabs,brd8022a", "silabs,wf200"; > + pinctrl-names = "default"; > + pinctrl-0 = <&wfx_wakeup>; > + reg = <1>; > + wakeup-gpios = <&gpio 12 GPIO_ACTIVE_HIGH>; > + }; > + }; > +... > -- > 2.34.1 >
On Tuesday 11 January 2022 23:19:56 CET Rob Herring wrote: > On Tue, Jan 11, 2022 at 06:14:02PM +0100, Jerome Pouiller wrote: > > From: Jérôme Pouiller <jerome.pouiller@silabs.com> > > > > Prepare the inclusion of the wfx driver in the kernel. > > > > Signed-off-by: Jérôme Pouiller <jerome.pouiller@silabs.com> > > --- > > .../bindings/net/wireless/silabs,wfx.yaml | 138 ++++++++++++++++++ > > 1 file changed, 138 insertions(+) > > create mode 100644 Documentation/devicetree/bindings/net/wireless/silabs,wfx.yaml > > > > diff --git a/Documentation/devicetree/bindings/net/wireless/silabs,wfx.yaml b/Documentation/devicetree/bindings/net/wireless/silabs,wfx.yaml > > new file mode 100644 > > index 000000000000..d12f262868cf > > --- /dev/null > > +++ b/Documentation/devicetree/bindings/net/wireless/silabs,wfx.yaml [...] > > +properties: > > + compatible: > > + anyOf: > > + - const: silabs,wf200 # Chip alone without antenna > > + - const: silabs,brd4001a # WGM160P Evaluation Board > > + - const: silabs,brd8022a # WF200 Evaluation Board > > + - const: silabs,brd8023a # WFM200 Evaluation Board > > This still defines that compatible is a single entry. You need something > like: > > items: > - enum: > - silabs,brd4001a > - silabs,brd8022a > - silabs,brd8023a > - const: silabs,wf200 > > You need a separate 'items' list for different number of compatible > entries (e.g. if a single string is valid) and that is when you need to > use 'oneOf'. Plenty of examples in the tree. Ok. [...] > > + interrupts: > > + description: The interrupt line. Triggers IRQ_TYPE_LEVEL_HIGH and > > + IRQ_TYPE_EDGE_RISING are both supported by the chip and the driver. When > > Unless there is a mode you can configure, supporting both is wrong even > though edge will mostly work for a device that is really level. > > What a driver supports is not relevant to the binding. hmm... right. > > + SPI is used, this property is required. When SDIO is used, the "in-band" > > + interrupt provided by the SDIO bus is used unless an interrupt is defined > > + in the Device Tree. > > + maxItems: 1 > > + > > + reset-gpios: > > + description: (SPI only) Phandle of gpio that will be used to reset chip > > + during probe. Without this property, you may encounter issues with warm > > + boot. (For legacy purpose, the gpio in inverted when compatible == > > + "silabs,wfx-spi") > > What legacy? This is a new binding. This driver already exist in staging/. But, it is probably the right moment to drop this legacy binding. [...]
diff --git a/Documentation/devicetree/bindings/net/wireless/silabs,wfx.yaml b/Documentation/devicetree/bindings/net/wireless/silabs,wfx.yaml new file mode 100644 index 000000000000..d12f262868cf --- /dev/null +++ b/Documentation/devicetree/bindings/net/wireless/silabs,wfx.yaml @@ -0,0 +1,138 @@ +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) +# Copyright (c) 2020, Silicon Laboratories, Inc. +%YAML 1.2 +--- + +$id: http://devicetree.org/schemas/net/wireless/silabs,wfx.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Silicon Labs WFxxx devicetree bindings + +maintainers: + - Jérôme Pouiller <jerome.pouiller@silabs.com> + +description: > + Support for the Wifi chip WFxxx from Silicon Labs. Currently, the only device + from the WFxxx series is the WF200 described here: + https://www.silabs.com/documents/public/data-sheets/wf200-datasheet.pdf + + The WF200 can be connected via SPI or via SDIO. + + For SDIO: + + Declaring the WFxxx chip in device tree is mandatory (usually, the VID/PID is + sufficient for the SDIO devices). + + It is recommended to declare a mmc-pwrseq on SDIO host above WFx. Without + it, you may encounter issues during reboot. The mmc-pwrseq should be + compatible with mmc-pwrseq-simple. Please consult + Documentation/devicetree/bindings/mmc/mmc-pwrseq-simple.yaml for more + information. + + For SPI: + + In add of the properties below, please consult + Documentation/devicetree/bindings/spi/spi-controller.yaml for optional SPI + related properties. + +properties: + compatible: + anyOf: + - const: silabs,wf200 # Chip alone without antenna + - const: silabs,brd4001a # WGM160P Evaluation Board + - const: silabs,brd8022a # WF200 Evaluation Board + - const: silabs,brd8023a # WFM200 Evaluation Board + + reg: + description: + When used on SDIO bus, <reg> must be set to 1. When used on SPI bus, it is + the chip select address of the device as defined in the SPI devices + bindings. + maxItems: 1 + + spi-max-frequency: true + + interrupts: + description: The interrupt line. Triggers IRQ_TYPE_LEVEL_HIGH and + IRQ_TYPE_EDGE_RISING are both supported by the chip and the driver. When + SPI is used, this property is required. When SDIO is used, the "in-band" + interrupt provided by the SDIO bus is used unless an interrupt is defined + in the Device Tree. + maxItems: 1 + + reset-gpios: + description: (SPI only) Phandle of gpio that will be used to reset chip + during probe. Without this property, you may encounter issues with warm + boot. (For legacy purpose, the gpio in inverted when compatible == + "silabs,wfx-spi") + + For SDIO, the reset gpio should declared using a mmc-pwrseq. + maxItems: 1 + + wakeup-gpios: + description: Phandle of gpio that will be used to wake-up chip. Without this + property, driver will disable most of power saving features. + maxItems: 1 + + silabs,antenna-config-file: + $ref: /schemas/types.yaml#/definitions/string + description: Use an alternative file for antenna configuration (aka + "Platform Data Set" in Silabs jargon). Default depends of "compatible" + string. For "silabs,wf200", the default is 'wf200.pds'. + + local-mac-address: true + + mac-address: true + +additionalProperties: false + +required: + - compatible + - reg + +examples: + - | + #include <dt-bindings/gpio/gpio.h> + #include <dt-bindings/interrupt-controller/irq.h> + + spi0 { + #address-cells = <1>; + #size-cells = <0>; + + wifi@0 { + compatible = "silabs,brd4001a", "silabs,wf200"; + pinctrl-names = "default"; + pinctrl-0 = <&wfx_irq &wfx_gpios>; + reg = <0>; + interrupts-extended = <&gpio 16 IRQ_TYPE_EDGE_RISING>; + wakeup-gpios = <&gpio 12 GPIO_ACTIVE_HIGH>; + reset-gpios = <&gpio 13 GPIO_ACTIVE_LOW>; + spi-max-frequency = <42000000>; + }; + }; + + - | + #include <dt-bindings/gpio/gpio.h> + #include <dt-bindings/interrupt-controller/irq.h> + + wfx_pwrseq: wfx_pwrseq { + compatible = "mmc-pwrseq-simple"; + pinctrl-names = "default"; + pinctrl-0 = <&wfx_reset>; + reset-gpios = <&gpio 13 GPIO_ACTIVE_LOW>; + }; + + mmc0 { + mmc-pwrseq = <&wfx_pwrseq>; + #address-cells = <1>; + #size-cells = <0>; + + wifi@1 { + compatible = "silabs,brd8022a", "silabs,wf200"; + pinctrl-names = "default"; + pinctrl-0 = <&wfx_wakeup>; + reg = <1>; + wakeup-gpios = <&gpio 12 GPIO_ACTIVE_HIGH>; + }; + }; +...