Convert NXP SJA1105 DSA driver to YAML
Subsystems (6)
Vladimir Oltean
maintainerv2 cover Convert NXP SJA1105 DSA driver to YAML
From: Vladimir Oltean <[email protected]>
This is an attempt to convert the SJA1105 driver to the YAML schema.
The SJA1105 driver has some custom device tree properties which caused validation problems in the previous attempt:
https://patchwork.kernel.org/project/netdevbpf/patch/[email protected]/
So now we are removing them, hoping that this will make the conversion easier to accept.
In order to do that, we introduce a new PHY interface type, "reverse RMII", which is like "reverse MII" (aka MII as a PHY) but for the reduced data width version of the protocol. This is a direct replacement for an rmii fixed-link. Now, rmii fixed-link interfaces behave as a MAC, and rev-rmii fixed-link interfaces behave as a PHY.
Vladimir Oltean (4):
net: phy: introduce PHY_INTERFACE_MODE_REVRMII
net: dsa: sja1105: apply RGMII delays based on the fixed-link property
net: dsa: sja1105: determine PHY/MAC role from PHY interface type
dt-bindings: net: dsa: sja1105: convert to YAML schema
.../bindings/net/dsa/nxp,sja1105.yaml | 89 ++++++++++ .../devicetree/bindings/net/dsa/sja1105.txt | 156 ------------------ .../bindings/net/ethernet-controller.yaml | 1 + drivers/net/dsa/sja1105/sja1105.h | 1 + drivers/net/dsa/sja1105/sja1105_main.c | 92 ++++------- include/linux/phy.h | 4 + 6 files changed, 127 insertions(+), 216 deletions(-) create mode 100644 Documentation/devicetree/bindings/net/dsa/nxp,sja1105.yaml delete mode 100644 Documentation/devicetree/bindings/net/dsa/sja1105.txt
Signature · 1 line
2.25.1
Vladimir Oltean
maintainerPATCH v2 1/4 net: phy: introduce PHY_INTERFACE_MODE_REVRMII
From: Vladimir Oltean <[email protected]>
The "reverse RMII" protocol name is a personal invention, derived from "reverse MII".
Just like MII, RMII is an asymmetric protocol in that a PHY behaves differently than a MAC. In the case of RMII, for example:
- the 50 MHz clock signals are either driven by the MAC or by an external oscillator (but never by the PHY).
- the PHY can transmit extra in-band control symbols via RXD[1:0] which the MAC is supposed to understand, but a PHY isn't.
The "reverse MII" protocol is not standardized either, except for this web document:
https://www.eetimes.com/reverse-media-independent-interface-revmii-block-architecture/#
In short, it means that the Ethernet controller speaks the 4-bit data parallel protocol from the perspective of a PHY (it acts like a PHY). This might mean that it implements clause 22 compatible registers, although that is optional - the important bit is that its pins can be connected to an MII MAC and it will 'just work'.
In this discussion thread:
https://lore.kernel.org/netdev/20210201214515.cx6ivvme2tlquge2@skbuf/
we agreed that it would be an abuse of terms to use the "RevMII" name for anything than the 4-bit parallel MII protocol. But since all the same concepts can be applied to the 2-bit Reduced MII protocol as well, here we are introducing a "Reverse RMII" protocol. This means: "behave like an RMII PHY".
--- .../devicetree/bindings/net/ethernet-controller.yaml | 1 + include/linux/phy.h | 4 ++++ 2 files changed, 5 insertions(+)
Documentation/devicetree/bindings/net/ethernet-controller.yaml +1 -0
@@ -68,6 +68,7 @@ properties: - tbi - rev-mii - rmii + - rev-rmii # RX and TX delays are added by the MAC when required - rgmii
include/linux/phy.h +4 -0
@@ -93,6 +93,7 @@ extern const int phy_10gbit_features_array[1];* @PHY_INTERFACE_MODE_TBI: Ten Bit Interface * @PHY_INTERFACE_MODE_REVMII: Reverse Media Independent Interface * @PHY_INTERFACE_MODE_RMII: Reduced Media Independent Interface +* @PHY_INTERFACE_MODE_REVRMII: Reduced Media Independent Interface in PHY role * @PHY_INTERFACE_MODE_RGMII: Reduced gigabit media-independent interface * @PHY_INTERFACE_MODE_RGMII_ID: RGMII with Internal RX+TX delay * @PHY_INTERFACE_MODE_RGMII_RXID: RGMII with Internal RX delay
@@ -126,6 +127,7 @@ typedef enum {PHY_INTERFACE_MODE_TBI ,PHY_INTERFACE_MODE_REVMII ,PHY_INTERFACE_MODE_RMII , +PHY_INTERFACE_MODE_REVRMII ,PHY_INTERFACE_MODE_RGMII ,PHY_INTERFACE_MODE_RGMII_ID , PHY_INTERFACE_MODE_RGMII_RXID,
@@ -185,6 +187,8 @@ static inline const char *phy_modes(phy_interface_t interface)return "rev-mii" ;case PHY_INTERFACE_MODE_RMII :return "rmii" ; +case PHY_INTERFACE_MODE_REVRMII : +return "rev-rmii" ;case PHY_INTERFACE_MODE_RGMII :return "rgmii" ;case PHY_INTERFACE_MODE_RGMII_ID :
Signature · 1 line
2.25.1
Re: [PATCH v2 net-next 1/4] net: phy: introduce PHY_INTERFACE_MODE_REVRMII
Quoted 25 lines · Vladimir Oltean
From: Vladimir Oltean <[email protected]>
The "reverse RMII" protocol name is a personal invention, derived from "reverse MII".
Just like MII, RMII is an asymmetric protocol in that a PHY behaves differently than a MAC. In the case of RMII, for example:
- the 50 MHz clock signals are either driven by the MAC or by an external oscillator (but never by the PHY).
- the PHY can transmit extra in-band control symbols via RXD[1:0] which the MAC is supposed to understand, but a PHY isn't.The "reverse MII" protocol is not standardized either, except for this web document:
https://www.eetimes.com/reverse-media-independent-interface-revmii-block-architecture/#In short, it means that the Ethernet controller speaks the 4-bit data parallel protocol from the perspective of a PHY (it acts like a PHY). This might mean that it implements clause 22 compatible registers, although that is optional - the important bit is that its pins can be connected to an MII MAC and it will 'just work'.
In this discussion thread:
https://lore.kernel.org/netdev/20210201214515.cx6ivvme2tlquge2@skbuf/
Quoted 7 lines
we agreed that it would be an abuse of terms to use the "RevMII" name for anything than the 4-bit parallel MII protocol. But since all the same concepts can be applied to the 2-bit Reduced MII protocol as well, here we are introducing a "Reverse RMII" protocol. This means: "behave like an RMII PHY".
Signed-off-by Vladimir Oltean <[email protected]>
Signature · 1 line
Florian
Vladimir Oltean
maintainerPATCH v2 2/4 net: dsa: sja1105: apply RGMII delays based on the fixed-link property
In reply to Vladimir OlteanFrom: Vladimir Oltean <[email protected]>
The sja1105 driver has an intermediate way of determining whether the RGMII delays should be applied by the PHY or by itself: by looking at the port role (PHY or MAC). The port can be put in the PHY role either explicitly (sja1105,role-phy) or implicitly (fixed-link).
We want to deprecate the sja1105,role-phy property, so all that remains is the fixed-link property. Introduce a "fixed_link" array of booleans in the driver, and use that to determine whether RGMII delays must be applied or not.
--- drivers/net/dsa/sja1105/sja1105.h | 1 + drivers/net/dsa/sja1105/sja1105_main.c | 28 +++++++++++++------------- 2 files changed, 15 insertions(+), 14 deletions(-)
drivers/net/dsa/sja1105/sja1105.h +1 -0
@@ -226,6 +226,7 @@ struct sja1105_private {bool rgmii_rx_delay[SJA1105_MAX_NUM_PORTS ];bool rgmii_tx_delay[SJA1105_MAX_NUM_PORTS ];phy_interface_t phy_mode[SJA1105_MAX_NUM_PORTS ]; +bool fixed_link[SJA1105_MAX_NUM_PORTS ];bool best_effort_vlan_filtering;unsigned long learn_ena;unsigned long ucast_egress_floods;
drivers/net/dsa/sja1105/sja1105_main.c +14 -14
@@ -799,26 +799,25 @@ static int sja1105_static_config_load(struct sja1105_private *priv,return sja1105_static_config_upload (priv); } -static int sja1105_parse_rgmii_delays (struct sja1105_private *priv, -const struct sja1105_dt_port *ports) +static int sja1105_parse_rgmii_delays (struct sja1105_private *priv) {struct dsa_switch *ds = priv->ds; -int i; +int port; -for (i =0 ; i < ds->num_ports; i++) { -if (ports[i].role ==XMII_MAC ) +for (port =0 ; port < ds->num_ports; port++) { +if (!priv->fixed_link[port])continue ; -if (ports[i].phy_mode ==PHY_INTERFACE_MODE_RGMII_RXID || - ports[i].phy_mode ==PHY_INTERFACE_MODE_RGMII_ID ) - priv->rgmii_rx_delay[i] = true; +if (priv->phy_mode[port] ==PHY_INTERFACE_MODE_RGMII_RXID || + priv->phy_mode[port] ==PHY_INTERFACE_MODE_RGMII_ID ) + priv->rgmii_rx_delay[port] = true; -if (ports[i].phy_mode ==PHY_INTERFACE_MODE_RGMII_TXID || - ports[i].phy_mode ==PHY_INTERFACE_MODE_RGMII_ID ) - priv->rgmii_tx_delay[i] = true; +if (priv->phy_mode[port] ==PHY_INTERFACE_MODE_RGMII_TXID || + priv->phy_mode[port] ==PHY_INTERFACE_MODE_RGMII_ID ) + priv->rgmii_tx_delay[port] = true; -if ((priv->rgmii_rx_delay[i] || priv->rgmii_tx_delay[i]) && - !priv->info->setup_rgmii_delay) +if ((priv->rgmii_rx_delay[port] || priv->rgmii_tx_delay[port]) && + !priv->info->setup_rgmii_delay)return -EINVAL ; }return 0 ;
@@ -867,6 +866,7 @@ static int sja1105_parse_ports_node(struct sja1105_private *priv,/* phy-handle is missing, but fixed-link isn't. * So it's a fixed link. Default to PHY role. */ + priv->fixed_link[index] = true; ports[index].role =XMII_PHY ; }else {/* phy-handle present => put port in MAC role */
@@ -3021,7 +3021,7 @@ static int sja1105_setup(struct dsa_switch *ds)/* Error out early if internal delays are required through DT * and we can't apply them. */ - rc =sja1105_parse_rgmii_delays (priv, ports); + rc =sja1105_parse_rgmii_delays (priv);if (rc <0 ) {dev_err (ds->dev,"RGMII delay not supported\n" );return rc;
Signature · 1 line
2.25.1
Re: [PATCH v2 net-next 2/4] net: dsa: sja1105: apply RGMII delays based on the fixed-link property
Quoted 7 lines · Vladimir Oltean
From: Vladimir Oltean <[email protected]>
The sja1105 driver has an intermediate way of determining whether the RGMII delays should be applied by the PHY or by itself: by looking at the port role (PHY or MAC). The port can be put in the PHY role either explicitly (sja1105,role-phy) or implicitly (fixed-link).
Quoted 6 lines
We want to deprecate the sja1105,role-phy property, so all that remains is the fixed-link property. Introduce a "
fixed_link" array of booleans in the driver, and use that to determine whether RGMII delays must be applied or not.Signed-off-by Vladimir Oltean <[email protected]>
Signature · 1 line
Florian
Vladimir Oltean
maintainerPATCH v2 3/4 net: dsa: sja1105: determine PHY/MAC role from PHY interface type
In reply to Vladimir OlteanFrom: Vladimir Oltean <[email protected]>
Now that both RevMII as well as RevRMII exist, we can deprecate the sja1105,role-mac and sja1105,role-phy properties and simply let the user select that a port operates in MII PHY role by using
phy-mode = "rev-mii"; or in RMII PHY role by using phy-mode = "rev-rmii";
There are no fixed-link MII or RMII properties in mainline device trees, and the setup itself is fairly uncommon, so there shouldn't be risks of breaking compatibility.
--- .../devicetree/bindings/net/dsa/sja1105.txt | 37 +---------- drivers/net/dsa/sja1105/sja1105_main.c | 64 ++++++------------- 2 files changed, 19 insertions(+), 82 deletions(-)
Documentation/devicetree/bindings/net/dsa/sja1105.txt +1 -36
@@ -19,37 +19,6 @@ Required properties: of support for RGMII internal delays (supported on P/Q/R/S, but not on E/T). -Optional properties: - -- sja1105,role-mac: -- sja1105,role-phy: - Boolean properties that can be assigned under each port node. By - default (unless otherwise specified) a port is configured as MAC if it - is driving a PHY (phy-handle is present) or as PHY if it is PHY-less - (fixed-link specified, presumably because it is connected to a MAC). - The effect of this property (in either its implicit or explicit form) - is: - - In the case of MII or RMII it specifies whether the SJA1105 port is a - clock source or sink for this interface (not applicable for RGMII - where there is a Tx and an Rx clock). - - In the case of RGMII it affects the behavior regarding internal - delays: - 1. If sja1105,role-mac is specified, and the phy-mode property is one - of "rgmii-id", "rgmii-txid" or "rgmii-rxid", then the entity - designated to apply the delay/clock skew necessary for RGMII - is the PHY. The SJA1105 MAC does not apply any internal delays. - 2. If sja1105,role-phy is specified, and the phy-mode property is one - of the above, the designated entity to apply the internal delays - is the SJA1105 MAC (if hardware-supported). This is only supported - by the second-generation (P/Q/R/S) hardware. On a first-generation - E or T device, it is an error to specify an RGMII phy-mode other - than "rgmii" for a port that is in fixed-link mode. In that case, - the clock skew must either be added by the MAC at the other end of - the fixed-link, or by PCB serpentine traces on the board. - These properties are required, for example, in the case where SJA1105 - ports are at both ends of a MII/RMII PHY-less setup. One end would need - to have sja1105,role-mac, while the other sja1105,role-phy. - See Documentation/devicetree/bindings/net/dsa/dsa.txt for the list of standard DSA required and optional properties.
@@ -87,7 +56,6 @@ arch/arm/boot/dts/ls1021a-tsn.dts: phy-handle = <&rgmii_phy6>; phy-mode = "rgmii-id"; reg = <0>; - /* Implicit "sja1105,role-mac;" */ }; port@1 { /* ETH2 written on chassis */
@@ -95,7 +63,6 @@ arch/arm/boot/dts/ls1021a-tsn.dts: phy-handle = <&rgmii_phy3>; phy-mode = "rgmii-id"; reg = <1>; - /* Implicit "sja1105,role-mac;" */ }; port@2 { /* ETH3 written on chassis */
@@ -103,7 +70,6 @@ arch/arm/boot/dts/ls1021a-tsn.dts: phy-handle = <&rgmii_phy4>; phy-mode = "rgmii-id"; reg = <2>; - /* Implicit "sja1105,role-mac;" */ }; port@3 { /* ETH4 written on chassis */
@@ -111,14 +77,13 @@ arch/arm/boot/dts/ls1021a-tsn.dts: label = "swp4"; phy-mode = "rgmii-id"; reg = <3>; - /* Implicit "sja1105,role-mac;" */ }; port@4 { /* Internal port connected to eth2 */ ethernet = <&enet2>; phy-mode = "rgmii"; reg = <4>; - /* Implicit "sja1105,role-phy;" */ + fixed-link { speed = <1000>; full-duplex;
drivers/net/dsa/sja1105/sja1105_main.c +18 -46
161 lines not on this page · raw message
Signature · 1 line
2.25.1
Re: [PATCH v2 net-next 3/4] net: dsa: sja1105: determine PHY/MAC role from PHY interface type
Quoted 9 lines · Vladimir Oltean
From: Vladimir Oltean <[email protected]>
Now that both RevMII as well as RevRMII exist, we can deprecate the sja1105,role-mac and sja1105,role-phy properties and simply let the user select that a port operates in MII PHY role by using
phy-mode = "rev-mii"; or in RMII PHY role by using phy-mode = "rev-rmii";
Quoted 5 lines
There are no fixed-link MII or RMII properties in mainline device trees, and the setup itself is fairly uncommon, so there shouldn't be risks of breaking compatibility.
Signed-off-by Vladimir Oltean <[email protected]>
Signature · 1 line
Florian
Vladimir Oltean
maintainerPATCH v2 4/4 dt-bindings: net: dsa: sja1105: convert to YAML schema
In reply to Vladimir OlteanFrom: Vladimir Oltean <[email protected]>
Since the sja1105 driver no longer has any custom device tree properties, the conversion is trivial.
--- .../bindings/net/dsa/nxp,sja1105.yaml | 89 +++++++++++++ .../devicetree/bindings/net/dsa/sja1105.txt | 121 ------------------ 2 files changed, 89 insertions(+), 121 deletions(-) create mode 100644 Documentation/devicetree/bindings/net/dsa/nxp,sja1105.yaml delete mode 100644 Documentation/devicetree/bindings/net/dsa/sja1105.txt
Documentation/devicetree/bindings/net/dsa/nxp,sja1105.yaml new file +89 -0
@@ -0,0 +1,89 @@ +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/net/dsa/nxp,sja1105.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: NXP SJA1105 Automotive Ethernet Switch Family Device Tree Bindings + +description: + The SJA1105 SPI interface requires a CS-to-CLK time (t2 in UM10944.pdf) of at + least one half of t_CLK. At an SPI frequency of 1MHz, this means a minimum + cs_sck_delay of 500ns. Ensuring that this SPI timing requirement is observed + depends on the SPI bus master driver. + +allOf: + - $ref: "dsa.yaml#" + +maintainers: + - Vladimir Oltean <[email protected]> + +properties: + compatible: + enum: + - nxp,sja1105e + - nxp,sja1105t + - nxp,sja1105p + - nxp,sja1105q + - nxp,sja1105r + - nxp,sja1105s + + reg: + maxItems: 1 + +required: + - compatible + - reg + +unevaluatedProperties: false + +examples: + - | + spi { + #address-cells = <1>; + #size-cells = <0>; + + ethernet-switch@1 { + reg = <0x1>; + compatible = "nxp,sja1105t"; + + ethernet-ports { + #address-cells = <1>; + #size-cells = <0>; + + port@0 { + phy-handle = <&rgmii_phy6>; + phy-mode = "rgmii-id"; + reg = <0>; + }; + + port@1 { + phy-handle = <&rgmii_phy3>; + phy-mode = "rgmii-id"; + reg = <1>; + }; + + port@2 { + phy-handle = <&rgmii_phy4>; + phy-mode = "rgmii-id"; + reg = <2>; + }; + + port@3 { + phy-mode = "rgmii-id"; + reg = <3>; + }; + + port@4 { + ethernet = <&enet2>; + phy-mode = "rgmii"; + reg = <4>; + + fixed-link { + speed = <1000>; + full-duplex; + }; + }; + }; + }; + };
Documentation/devicetree/bindings/net/dsa/sja1105.txt deleted +0 -121
121 lines not on this page · raw message
Signature · 1 line
2.25.1
This series was applied to netdev/net-next.git (refs/heads/master):
Hello:
This series was applied to netdev/net-next.git (refs/heads/master):
Quoted 9 lines · On Fri, 4 Jun 2021 17:01:47 +0300 you wrote:
From: Vladimir Oltean <[email protected]>
This is an attempt to convert the SJA1105 driver to the YAML schema.
The SJA1105 driver has some custom device tree properties which caused validation problems in the previous attempt:
https://patchwork.kernel.org/project/netdevbpf/patch/[email protected]/[...]
Here is the summary with links:
- [v2,net-next,1/4] net: phy: introduce PHY_INTERFACE_MODE_REVRMII
https://git.kernel.org/netdev/net-next/c/c858d436be8b - [v2,net-next,2/4] net: dsa: sja1105: apply RGMII delays based on the fixed-link property https://git.kernel.org/netdev/net-next/c/29afb83ac98e - [v2,net-next,3/4] net: dsa: sja1105: determine PHY/MAC role from PHY interface type https://git.kernel.org/netdev/net-next/c/5d645df99ac6 - [v2,net-next,4/4] dt-bindings: net: dsa: sja1105: convert to YAML schema https://git.kernel.org/netdev/net-next/c/62568bdbe6f6
You are awesome, thank you!
--
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html