Re: [PATCH v2 1/4] dt-bindings: net: Add bindings for AX88796C SPI Ethernet Adapter

From: Krzysztof Kozlowski <krzk@kernel.org>
To: "Łukasz Stelmach" <l.stelmach@samsung.com>
Cc: "David S. Miller" <davem@davemloft.net>,
	"Jakub Kicinski" <kuba@kernel.org>,
	"Kukjin Kim" <kgene@kernel.org>,
	"Rob Herring" <robh+dt@kernel.org>,
	"Russell King" <linux@armlinux.org.uk>,
	"Andrew Lunn" <andrew@lunn.ch>,
	jim.cromie@gmail.com, linux-arm-kernel@lists.infradead.org,
	"linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>,
	"linux-samsung-soc@vger.kernel.org"
	<linux-samsung-soc@vger.kernel.org>,
	netdev@vger.kernel.org, devicetree@vger.kernel.org,
	"Bartłomiej Żolnierkiewicz" <b.zolnierkie@samsung.com>,
	"Marek Szyprowski" <m.szyprowski@samsung.com>
Subject: Re: [PATCH v2 1/4] dt-bindings: net: Add bindings for AX88796C SPI Ethernet Adapter
Date: Sat, 3 Oct 2020 12:09:55 +0200	[thread overview]
Message-ID: <CAJKOXPeLiKQLSud4f9zxqBdR9a1sk04K56_=jtQr1FGxyDmDuQ@mail.gmail.com> (raw)
In-Reply-To: <20201002192210.19967-2-l.stelmach@samsung.com>

On Fri, 2 Oct 2020 at 21:22, Łukasz Stelmach <l.stelmach@samsung.com> wrote:
>
> Add bindings for AX88796C SPI Ethernet Adapter.
>
> Signed-off-by: Łukasz Stelmach <l.stelmach@samsung.com>
> ---
>  .../bindings/net/asix,ax88796c-spi.yaml       | 76 +++++++++++++++++++
>  .../devicetree/bindings/vendor-prefixes.yaml  |  2 +
>  2 files changed, 78 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/net/asix,ax88796c-spi.yaml
>
> diff --git a/Documentation/devicetree/bindings/net/asix,ax88796c-spi.yaml b/Documentation/devicetree/bindings/net/asix,ax88796c-spi.yaml
> new file mode 100644
> index 000000000000..50a488d59dbf
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/net/asix,ax88796c-spi.yaml
> @@ -0,0 +1,76 @@
> +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/net/asix,ax88796c-spi.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: ASIX AX88796C SPI Ethernet Adapter
> +
> +allOf:
> +  - $ref: ethernet-controller.yaml#

Order of top-level entries please:
1. id, schema
2. title
3. maintainers
4. description
and then allOf. See example-schema.yaml.

> +
> +description: |
> +  ASIX AX88796C is an Ethernet controller with a built in PHY. This
> +  describes SPI mode of the chip.
> +
> +  The node for this driver must be a child node of a SPI controller, hence
> +  all mandatory properties described in ../spi/spi-bus.txt must be specified.
> +
> +maintainers:
> +  - Łukasz Stelmach <l.stelmach@samsung.com>
> +
> +properties:
> +  compatible:
> +    const: asix,ax99796c-spi
> +
> +  reg:
> +    description:
> +      SPI device address.

Skip description, it's trivial.

> +    maxItems: 1
> +
> +  spi-max-frequency:
> +    maximum: 40000000
> +
> +  interrupts:
> +    description:
> +     GPIO interrupt to which the chip is connected.

Skip the description. It's trivial and might be not accurate (does not
have to be a GPIO).

> +    maxItems: 1
> +
> +  interrupt-parrent:
> +    description:
> +      A phandle of an interrupt controller.

Skip description.

> +    maxItems: 1
> +
> +  reset-gpios:
> +    description:
> +      A GPIO line handling reset of the chip. As the line is active low,
> +      it should be marked GPIO_ACTIVE_LOW.
> +    maxItems: 1
> +
> +  local-mac-address: true
> +
> +  mac-address: true
> +
> +required:
> +  - compatible
> +  - reg
> +  - spi-max-frequency
> +  - interrupts
> +  - interrupt-parrent
> +  - reset-gpios

Additional properties false.

> +
> +examples:
> +  # Artik5 eval board
> +  - |
> +    ax88796c@0 {
> +        compatible = "asix,ax88796c";
> +        local-mac-address = [00 00 00 00 00 00]; /* Filled in by a bootloader */
> +        interrupt-parent = <&gpx2>;
> +        interrupts = <0 IRQ_TYPE_LEVEL_LOW>;
> +        spi-max-frequency = <40000000>;
> +        reg = <0x0>;
> +        reset-gpios = <&gpe0 2 GPIO_ACTIVE_LOW>;
> +        controller-data {
> +            samsung,spi-feedback-delay = <2>;
> +        };
> +    };
> diff --git a/Documentation/devicetree/bindings/vendor-prefixes.yaml b/Documentation/devicetree/bindings/vendor-prefixes.yaml
> index 2baee2c817c1..5ce5c4a43735 100644
> --- a/Documentation/devicetree/bindings/vendor-prefixes.yaml
> +++ b/Documentation/devicetree/bindings/vendor-prefixes.yaml
> @@ -117,6 +117,8 @@ patternProperties:
>      description: Asahi Kasei Corp.
>    "^asc,.*":
>      description: All Sensors Corporation
> +  "^asix,.*":
> +    description: ASIX Electronics Corporation

Separate patch please.

Best regards,
Krzysztof

>    "^aspeed,.*":
>      description: ASPEED Technology Inc.
>    "^asus,.*":
> --
> 2.26.2
>