Documentation: Add MDIO bus node to PHY binding document
Subsystems (3)
PATCH 1/1 Documentation: Add MDIO bus node to PHY binding document
Add MDIO bus node segment and update the example, allowing trivial bindings to break out boilerplate.
---
Notes:
Changes per reply from Grant [0]
[0] http://lists.infradead.org/pipermail/linux-arm-kernel/2013-November/208851.html
Applies to next-20131111Documentation/devicetree/bindings/net/phy.txt | 37 +++++++++++++++++++++------ 1 file changed, 29 insertions(+), 8 deletions(-)
Documentation/devicetree/bindings/net/phy.txt +29 -8
@@ -1,3 +1,13 @@ +MDIO Bus Nodes + +MDIO bus nodes describe an MDIO bus. It is a container for PHY nodes as +described below. + +Required properties: +- #address-cells = <1>; +- #size-cells = <0>; + + PHY nodes Required properties:
@@ -23,13 +33,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>; + } +}
Signature · 6 lines
1.8.2.1 -- To unsubscribe from this list: send the line "unsubscribe devicetree" in the body of a message to [email protected] More majordomo info at http://vger.kernel.org/majordomo-info.html
Quoted 2 lines · Jonas Jensen
Add MDIO bus node segment and update the example, allowing trivial bindings to break out boilerplate.
Hi, I have a couple of (minor) comments.
Quoted 19 lines
Signed-off-by Jonas Jensen <[email protected]>---
Notes:
Changes per reply from Grant [0] [0] http://lists.infradead.org/pipermail/linux-arm-kernel/2013-November/208851.html Applies to next-20131111Documentation/devicetree/bindings/net/phy.txt | 37 +++++++++++++++++++++------ 1 file changed, 29 insertions(+), 8 deletions(-)Documentation/devicetree/bindings/net/phy.txt +0
-0
Documentation/devicetree/bindings/net/phy.txt line 4
Quoted 4 lines
Documentation/devicetree/bindings/net/phy.txt +4
-0@@ -1,3 +1,13 @@ +MDIO Bus Nodes + +MDIO bus nodes describe an MDIO bus. It is a container for PHY nodes as +described below.
Jumping between pllural and singular is a bit jarring, and I assume the node name is important (i.e. it should be named "mdio").
How about something like:
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".
Given it seems that the MDIO node is expected to live under the node for the MAC, it would be nice to have a statement to that effect here.
Documentation/devicetree/bindings/net/phy.txt line 8
Quoted 4 lines
Documentation/devicetree/bindings/net/phy.txt +4
-0+ +Required properties: +- #address-cells = <1>; +- #size-cells = <0>;
It would be nice to say what the address cell represents (the PHY address on the MDIO bus, I think?). Also this looks like a fragment of dts rather than a description. How about:
- #address-cells: Should be <1> - the PHY address on the MDIO bus
- #size-cells: Should be <0>
Otherwise, this looks fine to me.
Thanks,
Mark.
--
To unsubscribe from this list: send the line "unsubscribe devicetree" in the body of a message to [email protected] More majordomo info at http://vger.kernel.org/majordomo-info.html
PATCH v2 1/1 Documentation: Add MDIO bus node to PHY binding document
In reply to Jonas JensenAdd MDIO bus node segment and update the example, allowing trivial bindings to break out boilerplate.
---
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(-)
Documentation/devicetree/bindings/net/phy.txt +40 -8
@@ -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>; + } +}
Signature · 1 line
1.8.2.1
Quoted 4 lines · Le mercredi 13 novembre 2013, 15:07:49 Jonas Jensen a écrit :
Add MDIO bus node segment and update the example, allowing trivial bindings to break out boilerplate.
Signed-off-by Jonas Jensen <[email protected]>
Quoted 8 lines
---
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?
Please CC [email protected] too as there might be some interest from networking folks not actively following devicetree-discuss.
This does looks good to me, there is not much to be said to the point where I wonder if this even deserves such an example, but it cannot hurt.
Quoted 79 lines
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(-)
(quoted diff) +0
-0
b/Documentation/devicetree/bindings/net/phy.txtindex 7cd18fb..4179a70 100644Documentation/devicetree/bindings/net/phy.txt +40
-8@@ -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>; + } +}
Signature · 1 line
Florian