From: Wells Lu <wellslutw@gmail.com>
To: davem@davemloft.net, kuba@kernel.org, robh+dt@kernel.org,
netdev@vger.kernel.org, devicetree@vger.kernel.org,
linux-kernel@vger.kernel.org, p.zabel@pengutronix.de
Cc: wells.lu@sunplus.com, vincent.shih@sunplus.com,
Wells Lu <wellslutw@gmail.com>
Subject: [PATCH net-next v3 1/2] devicetree: bindings: net: Add bindings doc for Sunplus SP7021.
Date: Tue, 30 Nov 2021 18:02:51 +0800 [thread overview]
Message-ID: <1638266572-5831-2-git-send-email-wellslutw@gmail.com> (raw)
In-Reply-To: <1638266572-5831-1-git-send-email-wellslutw@gmail.com>
Add bindings documentation for Sunplus SP7021.
Signed-off-by: Wells Lu <wellslutw@gmail.com>
---
Changes in v3
- Addressed all comments from Mr. Andrew Lunn.
- Added node 'ethernet-ports' and sub-nodes 'port'.
- Moved properties phy-handle and phy-mode to sub-nodes 'port'.
- Limit maximum value of reg of ethernet-phy port to 30.
- Addressed all commetns from Mr. Rob Herring.
- Fixed wrong indentation in dt doc (yaml).
.../bindings/net/sunplus,sp7021-emac.yaml | 172 +++++++++++++++++++++
MAINTAINERS | 7 +
2 files changed, 179 insertions(+)
create mode 100644 Documentation/devicetree/bindings/net/sunplus,sp7021-emac.yaml
diff --git a/Documentation/devicetree/bindings/net/sunplus,sp7021-emac.yaml b/Documentation/devicetree/bindings/net/sunplus,sp7021-emac.yaml
new file mode 100644
index 0000000..b9b0635
--- /dev/null
+++ b/Documentation/devicetree/bindings/net/sunplus,sp7021-emac.yaml
@@ -0,0 +1,172 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+# Copyright (C) Sunplus Co., Ltd. 2021
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/net/sunplus,sp7021-emac.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Sunplus SP7021 Dual Ethernet MAC Device Tree Bindings
+
+maintainers:
+ - Wells Lu <wellslutw@gmail.com>
+
+description: |
+ Sunplus SP7021 dual 10M/100M Ethernet MAC controller.
+ Device node of the controller has following properties.
+
+properties:
+ compatible:
+ const: sunplus,sp7021-emac
+
+ reg:
+ items:
+ - description: the EMAC registers
+ - description: the MOON5 registers
+
+ reg-names:
+ items:
+ - const: emac
+ - const: moon5
+
+ interrupts:
+ description: |
+ Contains number and type of interrupt. Number should be 66.
+ Type should be high-level trigger.
+ maxItems: 1
+
+ clocks:
+ maxItems: 1
+
+ resets:
+ maxItems: 1
+
+ nvmem-cells:
+ items:
+ - description: nvmem cell address of MAC address of 1st MAC
+ - description: nvmem cell address of MAC address of 2nd MAC
+
+ nvmem-cell-names:
+ description: names corresponding to the nvmem cells of MAC address
+ items:
+ - const: mac_addr0
+ - const: mac_addr1
+
+ ethernet-ports:
+ type: object
+ description: Ethernet ports to PHY
+
+ properties:
+ "#address-cells":
+ const: 1
+
+ "#size-cells":
+ const: 0
+
+ patternProperties:
+ "^port@[0-1]$":
+ type: object
+ description: Port to PHY
+
+ properties:
+ reg:
+ minimum: 0
+ maximum: 1
+
+ phy-handle:
+ maxItems: 1
+
+ phy-mode:
+ maxItems: 1
+
+ required:
+ - reg
+ - phy-handle
+ - phy-mode
+
+ mdio:
+ type: object
+ description: external MDIO Bus
+
+ properties:
+ "#address-cells":
+ const: 1
+
+ "#size-cells":
+ const: 0
+
+ patternProperties:
+ "^ethernet-phy@[0-9a-f]+$":
+ type: object
+ description: external PHY node
+
+ properties:
+ reg:
+ minimum: 0
+ maximum: 30
+
+ required:
+ - reg
+
+additionalProperties: false
+
+required:
+ - compatible
+ - reg
+ - reg-names
+ - interrupts
+ - clocks
+ - resets
+ - pinctrl-0
+ - pinctrl-names
+ - nvmem-cells
+ - nvmem-cell-names
+ - ethernet-ports
+ - mdio
+
+examples:
+ - |
+ #include <dt-bindings/interrupt-controller/irq.h>
+ emac: emac@9c108000 {
+ compatible = "sunplus,sp7021-emac";
+ reg = <0x9c108000 0x400>, <0x9c000280 0x80>;
+ reg-names = "emac", "moon5";
+ interrupt-parent = <&intc>;
+ interrupts = <66 IRQ_TYPE_LEVEL_HIGH>;
+ clocks = <&clkc 0xa7>;
+ resets = <&rstc 0x97>;
+ pinctrl-0 = <&emac_demo_board_v3_pins>;
+ pinctrl-names = "default";
+ nvmem-cells = <&mac_addr0>, <&mac_addr1>;
+ nvmem-cell-names = "mac_addr0", "mac_addr1";
+
+ ethernet-ports {
+ #address-cells = <1>;
+ #size-cells = <0>;
+
+ port@0 {
+ reg = <0>;
+ phy-handle = <ð_phy0>;
+ phy-mode = "rmii";
+ };
+
+ port@1 {
+ reg = <1>;
+ phy-handle = <ð_phy1>;
+ phy-mode = "rmii";
+ };
+ };
+
+ mdio {
+ #address-cells = <1>;
+ #size-cells = <0>;
+
+ eth_phy0: ethernet-phy@0 {
+ reg = <0>;
+ };
+
+ eth_phy1: ethernet-phy@1 {
+ reg = <1>;
+ };
+ };
+ };
+...
diff --git a/MAINTAINERS b/MAINTAINERS
index da2fb28..f9f81ed 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -18242,6 +18242,13 @@ L: netdev@vger.kernel.org
S: Maintained
F: drivers/net/ethernet/dlink/sundance.c
+SUNPLUS ETHERNET DRIVER
+M: Wells Lu <wellslutw@gmail.com>
+L: netdev@vger.kernel.org
+S: Maintained
+W: https://sunplus-tibbo.atlassian.net/wiki/spaces/doc/overview
+F: Documentation/devicetree/bindings/net/sunplus,sp7021-emac.yaml
+
SUPERH
M: Yoshinori Sato <ysato@users.sourceforge.jp>
M: Rich Felker <dalias@libc.org>
--
2.7.4
next prev parent reply other threads:[~2021-11-30 10:03 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-11-30 10:02 [PATCH net-next v3 0/2] This is a patch series for pinctrl driver for Sunplus SP7021 SoC Wells Lu
2021-11-30 10:02 ` Wells Lu [this message]
2021-12-01 1:56 ` [PATCH net-next v3 1/2] devicetree: bindings: net: Add bindings doc for Sunplus SP7021 Andrew Lunn
2021-12-01 7:02 ` Wells Lu 呂芳騰
2021-11-30 10:02 ` [PATCH net-next v3 2/2] net: ethernet: Add driver " Wells Lu
2021-11-30 13:51 ` kernel test robot
2021-12-01 3:30 ` Andrew Lunn
2021-12-02 11:20 ` Wells Lu 呂芳騰
2021-12-02 13:04 ` Andrew Lunn
2021-12-02 18:46 ` Wells Lu 呂芳騰
2021-12-02 19:03 ` Andrew Lunn
2021-12-03 1:36 ` Wells Lu 呂芳騰
2021-11-30 20:17 ` [PATCH net-next v3 0/2] This is a patch series for pinctrl driver for Sunplus SP7021 SoC Andrew Lunn
2021-12-01 1:42 ` Wells Lu 呂芳騰
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=1638266572-5831-2-git-send-email-wellslutw@gmail.com \
--to=wellslutw@gmail.com \
--cc=davem@davemloft.net \
--cc=devicetree@vger.kernel.org \
--cc=kuba@kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=netdev@vger.kernel.org \
--cc=p.zabel@pengutronix.de \
--cc=robh+dt@kernel.org \
--cc=vincent.shih@sunplus.com \
--cc=wells.lu@sunplus.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).