From: Calvin Johnson <calvin.johnson@oss.nxp.com>
To: Grant Likely <grant.likely@arm.com>,
"Rafael J . Wysocki" <rafael@kernel.org>,
Jeremy Linton <jeremy.linton@arm.com>,
Andrew Lunn <andrew@lunn.ch>,
Andy Shevchenko <andy.shevchenko@gmail.com>,
Florian Fainelli <f.fainelli@gmail.com>,
Russell King - ARM Linux admin <linux@armlinux.org.uk>,
Cristi Sovaiala <cristian.sovaiala@nxp.com>,
Florin Laurentiu Chiculita <florinlaurentiu.chiculita@nxp.com>,
Ioana Ciornei <ioana.ciornei@nxp.com>,
Madalin Bucur <madalin.bucur@oss.nxp.com>,
Heikki Krogerus <heikki.krogerus@linux.intel.com>,
Marcin Wojtas <mw@semihalf.com>,
Pieter Jansen Van Vuuren <pieter.jansenvv@bamboosystems.io>,
Jon <jon@solid-run.com>, Saravana Kannan <saravanak@google.com>,
Randy Dunlap <rdunlap@infradead.org>
Cc: Laurentiu Tudor <laurentiu.tudor@nxp.com>,
linux-kernel@vger.kernel.org, linux.cj@gmail.com,
Diana Madalina Craciun <diana.craciun@nxp.com>,
netdev@vger.kernel.org, linux-arm-kernel@lists.infradead.org,
linux-acpi@vger.kernel.org,
Calvin Johnson <calvin.johnson@oss.nxp.com>,
Len Brown <lenb@kernel.org>,
"Rafael J. Wysocki" <rjw@rjwysocki.net>
Subject: [net-next PATCH v5 01/15] Documentation: ACPI: DSD: Document MDIO PHY
Date: Mon, 8 Feb 2021 20:42:30 +0530 [thread overview]
Message-ID: <20210208151244.16338-2-calvin.johnson@oss.nxp.com> (raw)
In-Reply-To: <20210208151244.16338-1-calvin.johnson@oss.nxp.com>
Introduce ACPI mechanism to get PHYs registered on a MDIO bus and
provide them to be connected to MAC.
Describe properties "phy-handle" and "phy-mode".
Signed-off-by: Calvin Johnson <calvin.johnson@oss.nxp.com>
---
Changes in v5:
- More cleanup
Changes in v4:
- More cleanup
Changes in v3: None
Changes in v2:
- Updated with more description in document
Documentation/firmware-guide/acpi/dsd/phy.rst | 133 ++++++++++++++++++
1 file changed, 133 insertions(+)
create mode 100644 Documentation/firmware-guide/acpi/dsd/phy.rst
diff --git a/Documentation/firmware-guide/acpi/dsd/phy.rst b/Documentation/firmware-guide/acpi/dsd/phy.rst
new file mode 100644
index 000000000000..e1e99cae5eb2
--- /dev/null
+++ b/Documentation/firmware-guide/acpi/dsd/phy.rst
@@ -0,0 +1,133 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+=========================
+MDIO bus and PHYs in ACPI
+=========================
+
+The PHYs on an MDIO bus [1] are probed and registered using
+fwnode_mdiobus_register_phy().
+
+Later, for connecting these PHYs to MAC, the PHYs registered on the
+MDIO bus have to be referenced.
+
+This document introduces two _DSD properties that are to be used
+for connecting PHYs on the MDIO bus [3] to the MAC layer.
+
+These properties are defined in accordance with the "Device
+Properties UUID For _DSD" [2] document and the
+daffd814-6eba-4d8c-8a91-bc9bbf4aa301 UUID must be used in the Device
+Data Descriptors containing them.
+
+phy-handle
+----------
+For each MAC node, a device property "phy-handle" is used to reference
+the PHY that is registered on an MDIO bus. This is mandatory for
+network interfaces that have PHYs connected to MAC via MDIO bus.
+
+During the MDIO bus driver initialization, PHYs on this bus are probed
+using the _ADR object as shown below and are registered on the MDIO bus.
+
+::
+ Scope(\_SB.MDI0)
+ {
+ Device(PHY1) {
+ Name (_ADR, 0x1)
+ } // end of PHY1
+
+ Device(PHY2) {
+ Name (_ADR, 0x2)
+ } // end of PHY2
+ }
+
+Later, during the MAC driver initialization, the registered PHY devices
+have to be retrieved from the MDIO bus. For this, the MAC driver need
+references to the previously registered PHYs which are provided
+as device object references (e.g. \_SB.MDI0.PHY1).
+
+phy-mode
+--------
+The "phy-mode" _DSD property is used to describe the connection to
+the PHY. The valid values for "phy-mode" are defined in [4].
+
+The following ASL example illustrates the usage of these properties.
+
+DSDT entry for MDIO node
+------------------------
+
+The MDIO bus has an SoC component (MDIO controller) and a platform
+component (PHYs on the MDIO bus).
+
+a) Silicon Component
+This node describes the MDIO controller, MDI0
+---------------------------------------------
+::
+ Scope(_SB)
+ {
+ Device(MDI0) {
+ Name(_HID, "NXP0006")
+ Name(_CCA, 1)
+ Name(_UID, 0)
+ Name(_CRS, ResourceTemplate() {
+ Memory32Fixed(ReadWrite, MDI0_BASE, MDI_LEN)
+ Interrupt(ResourceConsumer, Level, ActiveHigh, Shared)
+ {
+ MDI0_IT
+ }
+ }) // end of _CRS for MDI0
+ } // end of MDI0
+ }
+
+b) Platform Component
+The PHY1 and PHY2 nodes represent the PHYs connected to MDIO bus MDI0
+---------------------------------------------------------------------
+::
+ Scope(\_SB.MDI0)
+ {
+ Device(PHY1) {
+ Name (_ADR, 0x1)
+ } // end of PHY1
+
+ Device(PHY2) {
+ Name (_ADR, 0x2)
+ } // end of PHY2
+ }
+
+DSDT entries representing MAC nodes
+-----------------------------------
+
+Below are the MAC nodes where PHY nodes are referenced.
+phy-mode and phy-handle are used as explained earlier.
+------------------------------------------------------
+::
+ Scope(\_SB.MCE0.PR17)
+ {
+ Name (_DSD, Package () {
+ ToUUID("daffd814-6eba-4d8c-8a91-bc9bbf4aa301"),
+ Package () {
+ Package (2) {"phy-mode", "rgmii-id"},
+ Package (2) {"phy-handle", \_SB.MDI0.PHY1}
+ }
+ })
+ }
+
+ Scope(\_SB.MCE0.PR18)
+ {
+ Name (_DSD, Package () {
+ ToUUID("daffd814-6eba-4d8c-8a91-bc9bbf4aa301"),
+ Package () {
+ Package (2) {"phy-mode", "rgmii-id"},
+ Package (2) {"phy-handle", \_SB.MDI0.PHY2}}
+ }
+ })
+ }
+
+References
+==========
+
+[1] Documentation/networking/phy.rst
+
+[2] https://www.uefi.org/sites/default/files/resources/_DSD-device-properties-UUID.pdf
+
+[3] Documentation/firmware-guide/acpi/DSD-properties-rules.rst
+
+[4] Documentation/devicetree/bindings/net/ethernet-controller.yaml
--
2.17.1
next prev parent reply other threads:[~2021-02-08 16:39 UTC|newest]
Thread overview: 31+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-02-08 15:12 [net-next PATCH v5 00/15] ACPI support for dpaa2 driver Calvin Johnson
2021-02-08 15:12 ` Calvin Johnson [this message]
2021-02-08 20:01 ` [net-next PATCH v5 01/15] Documentation: ACPI: DSD: Document MDIO PHY Randy Dunlap
2021-02-09 14:34 ` Calvin Johnson
2021-02-08 15:12 ` [net-next PATCH v5 02/15] net: phy: Introduce fwnode_mdio_find_device() Calvin Johnson
2021-02-08 15:12 ` [net-next PATCH v5 03/15] net: phy: Introduce phy related fwnode functions Calvin Johnson
2021-02-08 15:12 ` [net-next PATCH v5 04/15] of: mdio: Refactor of_phy_find_device() Calvin Johnson
2021-02-08 15:12 ` [net-next PATCH v5 05/15] net: phy: Introduce fwnode_get_phy_id() Calvin Johnson
2021-02-08 15:12 ` [net-next PATCH v5 06/15] of: mdio: Refactor of_get_phy_id() Calvin Johnson
2021-02-08 15:12 ` [net-next PATCH v5 07/15] net: mdiobus: Introduce fwnode_mdiobus_register_phy() Calvin Johnson
2021-02-08 17:40 ` Russell King - ARM Linux admin
2021-02-09 15:04 ` Calvin Johnson
2021-02-08 15:12 ` [net-next PATCH v5 08/15] of: mdio: Refactor of_mdiobus_register_phy() Calvin Johnson
2021-02-08 15:12 ` [net-next PATCH v5 09/15] ACPI: utils: Introduce acpi_get_local_address() Calvin Johnson
2021-02-08 15:12 ` [net-next PATCH v5 10/15] net: mdio: Add ACPI support code for mdio Calvin Johnson
2021-02-08 16:16 ` Andy Shevchenko
2021-02-08 15:12 ` [net-next PATCH v5 11/15] net: mdiobus: Introduce fwnode_mdiobus_register() Calvin Johnson
2021-02-08 15:12 ` [net-next PATCH v5 12/15] net/fsl: Use fwnode_mdiobus_register() Calvin Johnson
2021-02-08 15:12 ` [net-next PATCH v5 13/15] phylink: introduce phylink_fwnode_phy_connect() Calvin Johnson
2021-02-08 15:31 ` Russell King - ARM Linux admin
2021-02-15 5:55 ` Calvin Johnson
2021-02-15 6:01 ` Calvin Johnson
2021-02-08 16:20 ` Russell King - ARM Linux admin
2021-02-08 15:12 ` [net-next PATCH v5 14/15] net: phylink: Refactor phylink_of_phy_connect() Calvin Johnson
2021-02-08 15:12 ` [net-next PATCH v5 15/15] net: dpaa2-mac: Add ACPI support for DPAA2 MAC driver Calvin Johnson
2021-02-08 16:21 ` Andy Shevchenko
2021-02-08 16:28 ` Russell King - ARM Linux admin
2021-02-15 12:33 ` Calvin Johnson
2021-02-15 15:13 ` Andy Shevchenko
2021-02-15 15:15 ` Andy Shevchenko
2021-02-16 9:59 ` Calvin Johnson
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=20210208151244.16338-2-calvin.johnson@oss.nxp.com \
--to=calvin.johnson@oss.nxp.com \
--cc=andrew@lunn.ch \
--cc=andy.shevchenko@gmail.com \
--cc=cristian.sovaiala@nxp.com \
--cc=diana.craciun@nxp.com \
--cc=f.fainelli@gmail.com \
--cc=florinlaurentiu.chiculita@nxp.com \
--cc=grant.likely@arm.com \
--cc=heikki.krogerus@linux.intel.com \
--cc=ioana.ciornei@nxp.com \
--cc=jeremy.linton@arm.com \
--cc=jon@solid-run.com \
--cc=laurentiu.tudor@nxp.com \
--cc=lenb@kernel.org \
--cc=linux-acpi@vger.kernel.org \
--cc=linux-arm-kernel@lists.infradead.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux.cj@gmail.com \
--cc=linux@armlinux.org.uk \
--cc=madalin.bucur@oss.nxp.com \
--cc=mw@semihalf.com \
--cc=netdev@vger.kernel.org \
--cc=pieter.jansenvv@bamboosystems.io \
--cc=rafael@kernel.org \
--cc=rdunlap@infradead.org \
--cc=rjw@rjwysocki.net \
--cc=saravanak@google.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).