devicetree.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Jonas Jensen <jonas.jensen@gmail.com>
To: devicetree@vger.kernel.org
Cc: grant.likely@secretlab.ca, rob.herring@calxeda.com,
	linux-kernel@vger.kernel.org, mark.rutland@arm.com,
	Jonas Jensen <jonas.jensen@gmail.com>
Subject: [PATCH v2] Documentation: Add MDIO bus node to PHY binding document
Date: Wed, 13 Nov 2013 15:07:49 +0100	[thread overview]
Message-ID: <1384351669-8325-1-git-send-email-jonas.jensen@gmail.com> (raw)
In-Reply-To: <1384174825-14249-1-git-send-email-jonas.jensen@gmail.com>

Add MDIO bus node segment and update the example,
allowing trivial bindings to break out boilerplate.

Signed-off-by: Jonas Jensen <jonas.jensen@gmail.com>
---

Notes:
    Thanks Mark,
    
    This should have the changes from your comments. It also adds optional properties "compatible" and "reg", were those overlooked or left out intentionally?
    
    Changes since v1:
    
    1. reformat "MDIO bus node" description and add, node name should be "mdio"
    2. reformat property descriptions, describe what the cells represent
    3. add optional properties
    4. add a description after "PHY nodes"
    
    Applies to next-20131113

 Documentation/devicetree/bindings/net/phy.txt | 48 ++++++++++++++++++++++-----
 1 file changed, 40 insertions(+), 8 deletions(-)

diff --git a/Documentation/devicetree/bindings/net/phy.txt b/Documentation/devicetree/bindings/net/phy.txt
index 7cd18fb..4179a70 100644
--- a/Documentation/devicetree/bindings/net/phy.txt
+++ b/Documentation/devicetree/bindings/net/phy.txt
@@ -1,5 +1,26 @@
+MDIO Bus Nodes
+
+An MDIO bus node describes an MDIO bus, and is a container for PHY nodes
+as described below. An MDIO bus node should be named "mdio".
+
+Required properties:
+
+- #address-cells = Should be <1>, specifies the number of cells needed
+  to encode the PHY address
+- #size-cells = Should be <0>
+
+Optional Properties:
+
+- compatible : Should contain a specific name for the MDIO bus,
+  if known, followed by "-mdio"
+- reg : Should contain register location and length
+
+
 PHY nodes
 
+Describes the PHY chip. A MAC connecting the PHY may use a phandle to
+this node.
+
 Required properties:
 
  - device_type : Should be "ethernet-phy"
@@ -23,13 +44,24 @@ Optional Properties:
   assume clause 22. The compatible list may also contain other
   elements.
 
+
 Example:
 
-ethernet-phy@0 {
-	compatible = "ethernet-phy-ieee802.3-c22";
-	linux,phandle = <2452000>;
-	interrupt-parent = <40000>;
-	interrupts = <35 1>;
-	reg = <0>;
-	device_type = "ethernet-phy";
-};
+mdio {
+	#address-cells = <1>;
+	#size-cells = <0>;
+
+	ethernet-phy@0 {
+		device_type = "ethernet-phy";
+		compatible = "...", "ethernet-phy-ieee802.3-c22";
+		reg = <0>;
+		interrupts = <24 0>;
+	}
+
+	ethernet-phy@1 {
+		device_type = "ethernet-phy";
+		compatible = "...";
+		reg = <1>;
+		interrupts = <35 1>;
+	}
+}
-- 
1.8.2.1

  parent reply	other threads:[~2013-11-13 14:07 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-11-11 13:00 [PATCH] Documentation: Add MDIO bus node to PHY binding document Jonas Jensen
     [not found] ` <1384174825-14249-1-git-send-email-jonas.jensen-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>
2013-11-11 14:57   ` Mark Rutland
2013-11-13 14:07 ` Jonas Jensen [this message]
2013-12-11  7:11   ` [PATCH v2] " Florian Fainelli

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=1384351669-8325-1-git-send-email-jonas.jensen@gmail.com \
    --to=jonas.jensen@gmail.com \
    --cc=devicetree@vger.kernel.org \
    --cc=grant.likely@secretlab.ca \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mark.rutland@arm.com \
    --cc=rob.herring@calxeda.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).