acpi/dsd/phy.rst

1 .. SPDX-License-Identifier: GPL-2.0
14 for connecting PHYs on the MDIO bus [dsd-properties-rules] to the MAC layer.
17 Properties UUID For _DSD" [dsd-guide] document and the
18 daffd814-6eba-4d8c-8a91-bc9bbf4aa301 UUID must be used in the Device
21 phy-handle
22 ----------
23 For each MAC node, a device property "phy-handle" is used to reference
25 network interfaces that have PHYs connected to MAC via MDIO bus.
30 .. code-block:: none
43 Later, during the MAC driver initialization, the registered PHY devices
44 have to be retrieved from the MDIO bus. For this, the MAC driver needs
48 phy-mode
49 --------
50 The "phy-mode" _DSD property is used to describe the connection to
51 the PHY. The valid values for "phy-mode" are defined in [ethernet-controller].
54 -------
56 The valid values for "managed" are defined in [ethernet-controller].
58 fixed-link
59 ----------
60 The "fixed-link" is described by a data-only subnode of the
61 MAC port, which is linked in the _DSD package via
62 hierarchical data extension (UUID dbb8e3e6-5886-4ba6-8795-1319f52a966b
63 in accordance with [dsd-guide] "_DSD Implementation Guide" document).
65 possibly the optional ones - complete list of parameters and
66 their values are specified in [ethernet-controller].
71 ------------------------
78 ---------------------------------------------
80 .. code-block:: none
100 ---------------------------------------------------------------------
102 .. code-block:: none
115 DSDT entries representing MAC nodes
116 -----------------------------------
118 Below are the MAC nodes where PHY nodes are referenced.
119 phy-mode and phy-handle are used as explained earlier.
120 ------------------------------------------------------
122 .. code-block:: none
127 	     ToUUID("daffd814-6eba-4d8c-8a91-bc9bbf4aa301"),
129 		     Package (2) {"phy-mode", "rgmii-id"},
130 		     Package (2) {"phy-handle", \_SB.MDI0.PHY1}
138 	    ToUUID("daffd814-6eba-4d8c-8a91-bc9bbf4aa301"),
140 		    Package (2) {"phy-mode", "rgmii-id"},
141 		    Package (2) {"phy-handle", \_SB.MDI0.PHY2}}
146 MAC node example where "managed" property is specified.
147 -------------------------------------------------------
149 .. code-block:: none
154 	     ToUUID("daffd814-6eba-4d8c-8a91-bc9bbf4aa301"),
156 		     Package () {"phy-mode", "sgmii"},
157 		     Package () {"managed", "in-band-status"}
162 MAC node example with a "fixed-link" subnode.
163 ---------------------------------------------
165 .. code-block:: none
170 	    ToUUID("daffd814-6eba-4d8c-8a91-bc9bbf4aa301"),
172 		     Package () {"phy-mode", "sgmii"},
174 	    ToUUID("dbb8e3e6-5886-4ba6-8795-1319f52a966b"),
176 		     Package () {"fixed-link", "LNK0"}
179 	  Name (LNK0, Package(){ // Data-only subnode of port
180 	    ToUUID("daffd814-6eba-4d8c-8a91-bc9bbf4aa301"),
183 		     Package () {"full-duplex", 1}
193 [dsd-properties-rules]
194     Documentation/firmware-guide/acpi/DSD-properties-rules.rst
196 [ethernet-controller]
197     Documentation/devicetree/bindings/net/ethernet-controller.yaml
199 [dsd-guide] DSD Guide.
200     https://github.com/UEFI/DSD-Guide/blob/main/dsd-guide.adoc, referenced
201     2021-11-30.