LKML Archive on lore.kernel.org
help / color / mirror / Atom feed
From: Rob Herring <robh@kernel.org>
To: Joel Stanley <joel@jms.id.au>
Cc: "David S . Miller" <davem@davemloft.net>,
	Jakub Kicinski <kuba@kernel.org>,
	Karol Gugala <kgugala@antmicro.com>,
	Mateusz Holenko <mholenko@antmicro.com>,
	devicetree@vger.kernel.org,
	Florent Kermarrec <florent@enjoy-digital.fr>,
	"Gabriel L . Somlo" <gsomlo@gmail.com>,
	netdev@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH v3 1/2] dt-bindings: net: Add bindings for LiteETH
Date: Wed, 25 Aug 2021 11:38:29 -0500	[thread overview]
Message-ID: <YSZyBVyb+AgDhkua@robh.at.kernel.org> (raw)
In-Reply-To: <20210825124655.3104348-2-joel@jms.id.au>

On Wed, Aug 25, 2021 at 10:16:54PM +0930, Joel Stanley wrote:
> LiteETH is a small footprint and configurable Ethernet core for FPGA
> based system on chips.
> 
> The hardware is parametrised by the size and number of the slots in it's
> receive and send buffers. These are described as properties, with the
> commonly used values set as the default.
> 
> Signed-off-by: Joel Stanley <joel@jms.id.au>
> ---
> v2:
>  - Fix dtschema check warning relating to registers
>  - Add names to the registers to make it easier to distinguish which is
>    what region
>  - Add mdio description
>  - Include ethernet-controller parent description
> v3:
>  - Define names for reg-names
>  - update example to match common case
>  - describe the hardware using slots and slot sizes. This is how the
>    hardware is pramaterised, and it makes more sense than trying to use
>    the rx/tx-fifo-size properties
> ---
>  .../bindings/net/litex,liteeth.yaml           | 100 ++++++++++++++++++
>  1 file changed, 100 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/net/litex,liteeth.yaml
> 
> diff --git a/Documentation/devicetree/bindings/net/litex,liteeth.yaml b/Documentation/devicetree/bindings/net/litex,liteeth.yaml
> new file mode 100644
> index 000000000000..62911b8e913c
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/net/litex,liteeth.yaml
> @@ -0,0 +1,100 @@
> +# SPDX-License-Identifier: GPL-2.0-or-later OR BSD-2-Clause
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/net/litex,liteeth.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: LiteX LiteETH ethernet device
> +
> +maintainers:
> +  - Joel Stanley <joel@jms.id.au>
> +
> +description: |
> +  LiteETH is a small footprint and configurable Ethernet core for FPGA based
> +  system on chips.
> +
> +  The hardware source is Open Source and can be found on at
> +  https://github.com/enjoy-digital/liteeth/.
> +
> +allOf:
> +  - $ref: ethernet-controller.yaml#
> +
> +properties:
> +  compatible:
> +    const: litex,liteeth
> +
> +  reg:
> +    minItems: 3

Don't need minItems if it is equal to 'items' length.

> +    items:
> +      - description: MAC registers
> +      - description: MDIO registers
> +      - description: Packet buffer
> +
> +  reg-names:
> +    minItems: 3

And here.

With that fixed:

Reviewed-by: Rob Herring <robh@kernel.org>

> +    items:
> +      - const: mac
> +      - const: mdio
> +      - const: buffer
> +
> +  interrupts:
> +    maxItems: 1
> +
> +  litex,rx-slots:
> +    description: Number of slots in the receive buffer
> +    $ref: /schemas/types.yaml#/definitions/uint32
> +    minimum: 1
> +    default: 2
> +
> +  litex,tx-slots:
> +    description: Number of slots in the transmit buffer
> +    $ref: /schemas/types.yaml#/definitions/uint32
> +    minimum: 1
> +    default: 2
> +
> +  litex,slot-size:
> +    description: Size in bytes of a slot in the tx/rx buffer
> +    $ref: /schemas/types.yaml#/definitions/uint32
> +    minimum: 0x800
> +    default: 0x800
> +
> +  mac-address: true
> +  local-mac-address: true
> +  phy-handle: true
> +
> +  mdio:
> +    $ref: mdio.yaml#
> +
> +required:
> +  - compatible
> +  - reg
> +  - interrupts
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    mac: ethernet@8020000 {
> +        compatible = "litex,liteeth";
> +        reg = <0x8021000 0x100>,
> +              <0x8020800 0x100>,
> +              <0x8030000 0x2000>;
> +        reg-names = "mac", "mdio", "buffer";
> +        litex,rx-slots = <2>;
> +        litex,tx-slots = <2>;
> +        litex,slot-size = <0x800>;
> +        interrupts = <0x11 0x1>;
> +        phy-handle = <&eth_phy>;
> +
> +        mdio {
> +          #address-cells = <1>;
> +          #size-cells = <0>;
> +
> +          eth_phy: ethernet-phy@0 {
> +            reg = <0>;
> +          };
> +        };
> +    };
> +...
> +
> +#  vim: set ts=2 sw=2 sts=2 tw=80 et cc=80 ft=yaml :
> -- 
> 2.33.0
> 
> 

  reply	other threads:[~2021-08-25 16:38 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-08-25 12:46 [PATCH v3 0/2] net: Add LiteETH network driver Joel Stanley
2021-08-25 12:46 ` [PATCH v3 1/2] dt-bindings: net: Add bindings for LiteETH Joel Stanley
2021-08-25 16:38   ` Rob Herring [this message]
2021-08-25 12:46 ` [PATCH v3 2/2] net: Add driver for LiteX's LiteETH network interface Joel Stanley
2021-08-25 22:04   ` Gabriel L. Somlo

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=YSZyBVyb+AgDhkua@robh.at.kernel.org \
    --to=robh@kernel.org \
    --cc=davem@davemloft.net \
    --cc=devicetree@vger.kernel.org \
    --cc=florent@enjoy-digital.fr \
    --cc=gsomlo@gmail.com \
    --cc=joel@jms.id.au \
    --cc=kgugala@antmicro.com \
    --cc=kuba@kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mholenko@antmicro.com \
    --cc=netdev@vger.kernel.org \
    --subject='Re: [PATCH v3 1/2] dt-bindings: net: Add bindings for LiteETH' \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).