From: Rob Herring <robh@kernel.org>
To: Kurt Kanzenbach <kurt@linutronix.de>
Cc: Andrew Lunn <andrew@lunn.ch>,
Vivien Didelot <vivien.didelot@gmail.com>,
Florian Fainelli <f.fainelli@gmail.com>,
"David S. Miller" <davem@davemloft.net>,
Jakub Kicinski <kuba@kernel.org>,
netdev@vger.kernel.org, devicetree@vger.kernel.org,
Sebastian Andrzej Siewior <bigeasy@linutronix.de>,
Richard Cochran <richardcochran@gmail.com>,
Kamil Alkhouri <kamil.alkhouri@hs-offenburg.de>,
ilias.apalodimas@linaro.org, Vladimir Oltean <olteanv@gmail.com>
Subject: Re: [PATCH v2 8/8] dt-bindings: net: dsa: Add documentation for Hellcreek switches
Date: Thu, 23 Jul 2020 14:37:10 -0600 [thread overview]
Message-ID: <20200723203710.GA810197@bogus> (raw)
In-Reply-To: <20200723081714.16005-9-kurt@linutronix.de>
On Thu, Jul 23, 2020 at 10:17:14AM +0200, Kurt Kanzenbach wrote:
> Add basic documentation and example.
>
> Signed-off-by: Kurt Kanzenbach <kurt@linutronix.de>
> ---
> .../bindings/net/dsa/hellcreek.yaml | 126 ++++++++++++++++++
> 1 file changed, 126 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/net/dsa/hellcreek.yaml
>
> diff --git a/Documentation/devicetree/bindings/net/dsa/hellcreek.yaml b/Documentation/devicetree/bindings/net/dsa/hellcreek.yaml
> new file mode 100644
> index 000000000000..1b192ba7f4ca
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/net/dsa/hellcreek.yaml
> @@ -0,0 +1,126 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/net/dsa/hellcreek.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Hirschmann Hellcreek TSN Switch Device Tree Bindings
> +
> +allOf:
> + - $ref: dsa.yaml#
> +
> +maintainers:
> + - Andrew Lunn <andrew@lunn.ch>
> + - Florian Fainelli <f.fainelli@gmail.com>
> + - Vivien Didelot <vivien.didelot@gmail.com>
> + - Kurt Kanzenbach <kurt@linutronix.de>
> +
> +description:
> + The Hellcreek TSN Switch IP is a 802.1Q Ethernet compliant switch. It supports
> + the Precision Time Protocol, Hardware Timestamping as well the Time Aware
> + Shaper.
> +
> +properties:
> + compatible:
> + oneOf:
> + - const: hirschmann,hellcreek
Don't need 'oneOf' for 1 entry.
> +
> + reg:
> + description:
> + The physical base address and size of TSN and PTP memory base
> + minItems: 2
> + maxItems: 2
> +
> + reg-names:
> + description:
> + Names of the physical base addresses
No need for generic descriptions. That's all 'reg-names'...
> + minItems: 2
> + maxItems: 2
> + items:
> + enum: ["reg", "ptp"]
Why not 'tsn' as above instead of reg? In any case, the correct form is:
items:
- const: reg
- const: ptp
> +
> + leds:
> + type: object
> + properties:
> + '#address-cells':
> + const: 1
> + '#size-cells':
> + const: 0
> +
> + patternProperties:
> + "^led@[0-9]+$":
> + type: object
> + description: Hellcreek leds
This should reference leds/common.yaml
> +
> + properties:
> + reg:
> + items:
> + - enum: [0, 1]
> + description: Led number
> +
> + label: true
> +
> + default-state: true
> +
> + required:
> + - reg
> +
> + additionalProperties: false
> +
> +required:
> + - compatible
> + - reg
> + - reg-names
> + - ports
Use the preferred 'ethernet-ports'.
> + - leds
Add:
unevaluatedProperties: false
> +
> +examples:
> + - |
> + switch0: switch@ff240000 {
> + compatible = "hirschmann,hellcreek";
> + status = "okay";
Don't show status in examples.
> + reg = <0xff240000 0x1000>,
> + <0xff250000 0x1000>;
> + reg-names = "reg", "ptp";
> + dsa,member = <0 0>;
> +
> + ports {
> + #address-cells = <1>;
> + #size-cells = <0>;
> +
> + port@0 {
> + reg = <0>;
> + label = "cpu";
> + ethernet = <&gmac0>;
> + };
> +
> + port@2 {
> + reg = <2>;
> + label = "lan0";
> + phy-handle = <&phy1>;
> + };
> +
> + port@3 {
> + reg = <3>;
> + label = "lan1";
> + phy-handle = <&phy2>;
> + };
> + };
> +
> + leds {
> + #address-cells = <1>;
> + #size-cells = <0>;
> +
> + led@0 {
> + reg = <0>;
> + label = "sync_good";
> + default-state = "on";
> + };
> +
> + led@1 {
> + reg = <1>;
> + label = "is_gm";
> + default-state = "off";
> + };
> + };
> + };
> --
> 2.20.1
>
next prev parent reply other threads:[~2020-07-23 20:37 UTC|newest]
Thread overview: 15+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-07-23 8:17 [PATCH v2 0/8] Hirschmann Hellcreek DSA driver Kurt Kanzenbach
2020-07-23 8:17 ` [PATCH v2 1/8] net: dsa: Add tag handling for Hirschmann Hellcreek switches Kurt Kanzenbach
2020-07-23 8:17 ` [PATCH v2 2/8] net: dsa: Add DSA driver " Kurt Kanzenbach
2020-07-23 8:17 ` [PATCH v2 3/8] net: dsa: hellcreek: Add PTP clock support Kurt Kanzenbach
2020-07-23 8:17 ` [PATCH v2 4/8] net: dsa: hellcreek: Add support for hardware timestamping Kurt Kanzenbach
2020-07-24 2:34 ` kernel test robot
2020-07-23 8:17 ` [PATCH v2 5/8] net: dsa: hellcreek: Add TAPRIO offloading support Kurt Kanzenbach
2020-07-23 8:17 ` [PATCH v2 6/8] net: dsa: hellcreek: Add PTP status LEDs Kurt Kanzenbach
2020-07-23 8:17 ` [PATCH v2 7/8] dt-bindings: Add vendor prefix for Hirschmann Kurt Kanzenbach
2020-07-23 8:17 ` [PATCH v2 8/8] dt-bindings: net: dsa: Add documentation for Hellcreek switches Kurt Kanzenbach
2020-07-23 20:37 ` Rob Herring [this message]
2020-07-23 16:33 ` [PATCH v2 0/8] Hirschmann Hellcreek DSA driver Jakub Kicinski
2020-07-24 6:04 ` Kurt Kanzenbach
2020-07-24 23:47 ` David Miller
2020-07-25 7:02 ` Kurt Kanzenbach
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=20200723203710.GA810197@bogus \
--to=robh@kernel.org \
--cc=andrew@lunn.ch \
--cc=bigeasy@linutronix.de \
--cc=davem@davemloft.net \
--cc=devicetree@vger.kernel.org \
--cc=f.fainelli@gmail.com \
--cc=ilias.apalodimas@linaro.org \
--cc=kamil.alkhouri@hs-offenburg.de \
--cc=kuba@kernel.org \
--cc=kurt@linutronix.de \
--cc=netdev@vger.kernel.org \
--cc=olteanv@gmail.com \
--cc=richardcochran@gmail.com \
--cc=vivien.didelot@gmail.com \
/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
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
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).