| Message ID | 20220503105528.12824-2-kavyasree.kotagiri@microchip.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | Add support for lan966 flexcom multiplexer | expand |
On 03/05/2022 12:55, Kavyasree Kotagiri wrote: > Convert the Atmel flexcom device tree bindings to json schema. > > Signed-off-by: Kavyasree Kotagiri <kavyasree.kotagiri@microchip.com> > --- > .../bindings/mfd/atmel,flexcom.yaml | 68 +++++++++++++++++++ > .../devicetree/bindings/mfd/atmel-flexcom.txt | 63 ----------------- > 2 files changed, 68 insertions(+), 63 deletions(-) > create mode 100644 Documentation/devicetree/bindings/mfd/atmel,flexcom.yaml > delete mode 100644 Documentation/devicetree/bindings/mfd/atmel-flexcom.txt > Thank you for your patch. There is something to discuss/improve. > diff --git a/Documentation/devicetree/bindings/mfd/atmel,flexcom.yaml b/Documentation/devicetree/bindings/mfd/atmel,flexcom.yaml > new file mode 100644 > index 000000000000..62dea9b891d8 > --- /dev/null > +++ b/Documentation/devicetree/bindings/mfd/atmel,flexcom.yaml > @@ -0,0 +1,68 @@ > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) > +%YAML 1.2 > +--- > +$id: http://devicetree.org/schemas/mfd/atmel,flexcom.yaml# > +$schema: http://devicetree.org/meta-schemas/core.yaml# > + > +title: Device tree bindings for Atmel Flexcom (Flexible Serial Communication Unit) > + > +maintainers: > + - Rob Herring <robh+dt@kernel.org> Person with access to hardware/datasheet/knowledge should be here, not DT bindings maintainer. > + > +description: | No need for "|" > + The Atmel Flexcom is just a wrapper which embeds a SPI controller, > + an I2C controller and an USART. Only one function can be used at a > + time and is chosen at boot time according to the device tree. > + > +properties: > + compatible: > + enum: > + - atmel,sama5d2-flexcom > + > + reg: > + minItems: 1 no need for minItems > + items: > + - description: Flexcom registers Description is obvious, so just replace all three lines with maxItems: 1 > + > + clocks: > + maxItems: 1 > + > + "#address-cells": true > + > + "#size-cells": true These should have some fixed value (e.g. const: 1). Second question - they do not look valid since you do not have any children nodes. It looks like you want children, so you need to define them. > + > + ranges: > + description: > + One range for the full I/O register region. (including USART, > + TWI and SPI registers). > + items: > + minItems: 3 no need for minItems > + maxItems: 3 > + > + atmel,flexcom-mode: > + description: > + One of the values. UART, I2C, SPI. This does not describe anything. If you have defines here, mention the header. > + $ref: /schemas/types.yaml#/definitions/uint32 > + enum: [0, 1, 2] Here is 0 not UART? > + > +required: > + - compatible > + - reg > + - clocks > + - "#address-cells" > + - "#size-cells" > + > +additionalProperties: false > + > +examples: > + - | > + flx0: flexcom@f8034000 {> + compatible = "atmel,sama5d2-flexcom"; > + reg = <0xf8034000 0x200>; > + clocks = <&flx0_clk>; > + #address-cells = <1>; > + #size-cells = <1>; No need for address/size - no children here. > + ranges = <0x0 0xf8034000 0x800>; Why do you need ranges without children? Best regards, Krzysztof
On Tue, 03 May 2022 16:25:25 +0530, Kavyasree Kotagiri wrote: > Convert the Atmel flexcom device tree bindings to json schema. > > Signed-off-by: Kavyasree Kotagiri <kavyasree.kotagiri@microchip.com> > --- > .../bindings/mfd/atmel,flexcom.yaml | 68 +++++++++++++++++++ > .../devicetree/bindings/mfd/atmel-flexcom.txt | 63 ----------------- > 2 files changed, 68 insertions(+), 63 deletions(-) > create mode 100644 Documentation/devicetree/bindings/mfd/atmel,flexcom.yaml > delete mode 100644 Documentation/devicetree/bindings/mfd/atmel-flexcom.txt > 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/mfd/atmel,flexcom.yaml: properties:reg: 'oneOf' conditional failed, one must be fixed: [{'description': 'Flexcom registers'}] is too short False schema does not allow 1 hint: "minItems" is only needed if less than the "items" list length from schema $id: http://devicetree.org/meta-schemas/items.yaml# /builds/robherring/linux-dt-review/Documentation/devicetree/bindings/mfd/atmel,flexcom.yaml: ignoring, error in schema: properties: reg Documentation/devicetree/bindings/mfd/atmel,flexcom.example.dtb:0:0: /example-0/flexcom@f8034000: failed to match any schema with compatible: ['atmel,sama5d2-flexcom'] doc reference errors (make refcheckdocs): See https://patchwork.ozlabs.org/patch/ 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.
diff --git a/Documentation/devicetree/bindings/mfd/atmel,flexcom.yaml b/Documentation/devicetree/bindings/mfd/atmel,flexcom.yaml new file mode 100644 index 000000000000..62dea9b891d8 --- /dev/null +++ b/Documentation/devicetree/bindings/mfd/atmel,flexcom.yaml @@ -0,0 +1,68 @@ +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/mfd/atmel,flexcom.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Device tree bindings for Atmel Flexcom (Flexible Serial Communication Unit) + +maintainers: + - Rob Herring <robh+dt@kernel.org> + +description: | + The Atmel Flexcom is just a wrapper which embeds a SPI controller, + an I2C controller and an USART. Only one function can be used at a + time and is chosen at boot time according to the device tree. + +properties: + compatible: + enum: + - atmel,sama5d2-flexcom + + reg: + minItems: 1 + items: + - description: Flexcom registers + + clocks: + maxItems: 1 + + "#address-cells": true + + "#size-cells": true + + ranges: + description: + One range for the full I/O register region. (including USART, + TWI and SPI registers). + items: + minItems: 3 + maxItems: 3 + + atmel,flexcom-mode: + description: + One of the values. UART, I2C, SPI. + $ref: /schemas/types.yaml#/definitions/uint32 + enum: [0, 1, 2] + +required: + - compatible + - reg + - clocks + - "#address-cells" + - "#size-cells" + +additionalProperties: false + +examples: + - | + flx0: flexcom@f8034000 { + compatible = "atmel,sama5d2-flexcom"; + reg = <0xf8034000 0x200>; + clocks = <&flx0_clk>; + #address-cells = <1>; + #size-cells = <1>; + ranges = <0x0 0xf8034000 0x800>; + atmel,flexcom-mode = <2>; + }; +... diff --git a/Documentation/devicetree/bindings/mfd/atmel-flexcom.txt b/Documentation/devicetree/bindings/mfd/atmel-flexcom.txt deleted file mode 100644 index 692300117c64..000000000000 --- a/Documentation/devicetree/bindings/mfd/atmel-flexcom.txt +++ /dev/null @@ -1,63 +0,0 @@ -* Device tree bindings for Atmel Flexcom (Flexible Serial Communication Unit) - -The Atmel Flexcom is just a wrapper which embeds a SPI controller, an I2C -controller and an USART. Only one function can be used at a time and is chosen -at boot time according to the device tree. - -Required properties: -- compatible: Should be "atmel,sama5d2-flexcom" -- reg: Should be the offset/length value for Flexcom dedicated - I/O registers (without USART, TWI or SPI registers). -- clocks: Should be the Flexcom peripheral clock from PMC. -- #address-cells: Should be <1> -- #size-cells: Should be <1> -- ranges: Should be one range for the full I/O register region - (including USART, TWI and SPI registers). -- atmel,flexcom-mode: Should be one of the following values: - - <1> for USART - - <2> for SPI - - <3> for I2C - -Required child: -A single available child device of type matching the "atmel,flexcom-mode" -property. - -The phandle provided by the clocks property of the child is the same as one for -the Flexcom parent. - -For other properties, please refer to the documentations of the respective -device: -- ../serial/atmel-usart.txt -- ../spi/spi_atmel.txt -- ../i2c/i2c-at91.txt - -Example: - -flexcom@f8034000 { - compatible = "atmel,sama5d2-flexcom"; - reg = <0xf8034000 0x200>; - clocks = <&flx0_clk>; - #address-cells = <1>; - #size-cells = <1>; - ranges = <0x0 0xf8034000 0x800>; - atmel,flexcom-mode = <2>; - - spi@400 { - compatible = "atmel,at91rm9200-spi"; - reg = <0x400 0x200>; - interrupts = <19 IRQ_TYPE_LEVEL_HIGH 7>; - pinctrl-names = "default"; - pinctrl-0 = <&pinctrl_flx0_default>; - #address-cells = <1>; - #size-cells = <0>; - clocks = <&flx0_clk>; - clock-names = "spi_clk"; - atmel,fifo-size = <32>; - - mtd_dataflash@0 { - compatible = "atmel,at25f512b"; - reg = <0>; - spi-max-frequency = <20000000>; - }; - }; -};
Convert the Atmel flexcom device tree bindings to json schema. Signed-off-by: Kavyasree Kotagiri <kavyasree.kotagiri@microchip.com> --- .../bindings/mfd/atmel,flexcom.yaml | 68 +++++++++++++++++++ .../devicetree/bindings/mfd/atmel-flexcom.txt | 63 ----------------- 2 files changed, 68 insertions(+), 63 deletions(-) create mode 100644 Documentation/devicetree/bindings/mfd/atmel,flexcom.yaml delete mode 100644 Documentation/devicetree/bindings/mfd/atmel-flexcom.txt