Skip to content

net: phy: add support for shared interrupts (part 1)

Ioana Ciornei lkml netdev 2 versions – Applied

Status from this message: Applied, thank you!

Get series with b4
b4 am [email protected]

Versions newest first · linked by author and title

  1. v2 Latest19 patches 11 repliesApplied
  2. v119 patches 12 repliesSuperseded

Changes in v2 from the cover letter

- Rework the .handle_interrupt() implementation for each driver so that only the enabled interrupts are taken into account when IRQ_NONE/IRQ_HANDLED it returned. The main idea is so that we avoid falsely blaming a device for triggering an interrupt when this is not the case.
The only devices for which I was unable to make this adjustment were the BCM8706, BCM8727, BCMAC131 and BCM5241 since I do not have access to their datasheets.
- I also updated the pseudo-code added in the cover-letter so that it's more clear how a .handle_interrupt() callback should look like.

Patches in v2 Applied

#Subject and filesSizeRepliesApplied
1/19net: phy: export phy_error and phy_trigger_machinedrivers/net/phy/phy.c include/linux/phy.h+6 -20 replies
2/19net: phy: add a shutdown proceduredrivers/net/phy/phy_device.c+8 -03 replies
3/19net: phy: make .ack_interrupt() optionaldrivers/net/phy/phy_device.c+1 -10 replies
4/19net: phy: at803x: implement generic .handle_interrupt() callbackdrivers/net/phy/at803x.c+31 -01 reply
5/19net: phy: at803x: remove the use of .ack_interrupt()drivers/net/phy/at803x.c+12 -71 reply
6/19net: phy: mscc: use phy_trigger_machine() to notify link changedrivers/net/phy/mscc/mscc_main.c+1 -11 reply
7/19net: phy: mscc: implement generic .handle_interrupt() callbackdrivers/net/phy/mscc/mscc_main.c+28 -281 reply
8/19net: phy: mscc: remove the use of .ack_interrupt()drivers/net/phy/mscc/mscc_main.c+8 -41 reply
9/19net: phy: aquantia: implement generic .handle_interrupt() callbackdrivers/net/phy/aquantia_main.c+27 -00 replies
10/19net: phy: aquantia: remove the use of .ack_interrupt()drivers/net/phy/aquantia_main.c+19 -170 replies
11/19net: phy: broadcom: implement generic .handle_interrupt() callbackdrivers/net/phy/bcm-cygnus.c drivers/net/phy/bcm-phy-lib.c drivers/net/phy/bcm-phy-lib.h +4 more+114 -150 replies
12/19net: phy: broadcom: remove use of ack_interrupt()drivers/net/phy/bcm-cygnus.c drivers/net/phy/bcm-phy-lib.c drivers/net/phy/bcm54140.c +3 more+68 -570 replies
13/19net: phy: cicada: implement the generic .handle_interrupt() callbackdrivers/net/phy/cicada.c+20 -00 replies
14/19net: phy: cicada: remove the use of .ack_interrupt()drivers/net/phy/cicada.c+11 -40 replies
15/19net: phy: davicom: implement generic .handle_interrupt() calbackdrivers/net/phy/davicom.c+26 -00 replies
16/19net: phy: davicom: remove the use of .ack_interrupt()drivers/net/phy/davicom.c+21 -160 replies
17/19net: phy: add genphy_handle_interrupt_no_ack()drivers/net/phy/phy_device.c include/linux/phy.h+14 -00 replies
18/19net: phy: realtek: implement generic .handle_interrupt() callbackdrivers/net/phy/realtek.c+72 -00 replies
19/19net: phy: realtek: remove the use of .ack_interrupt()drivers/net/phy/realtek.c+52 -160 replies

Reviews trailers per patch

None of the 19 patches has a Reviewed-by or Acked-by.

PatchAndrew LunnMichael WalleOleksij RempelVladimir Oltean
SeriesT-b T-b
1/19
2/19
3/19
4/19T-b
5/19T-b
6/19T-b
7/19T-b
8/19T-b
9/19
10/19
11/19
12/19
13/19
14/19
15/19
16/19
17/19
18/19
19/19

Trailers given in replies are filled; those carried in the patches from earlier versions are outlined with dashes. Scroll the table sideways for all 4 reviewers.

Read the v2 thread

Cover letter [PATCH net-next v2 00/19] net: phy: add support for shared interrupts (part 1)

From: Ioana Ciornei <[email protected]>

This patch set aims to actually add support for shared interrupts in phylib and not only for multi-PHY devices. While we are at it, streamline the interrupt handling in phylib.

For a bit of context, at the moment, there are multiple phy_driver ops that deal with this subject:

- .config_intr() - Enable/disable the interrupt line.

- .ack_interrupt() - Should quiesce any interrupts that may have been fired. It's also used by phylib in conjunction with .config_intr() to clear any pending interrupts after the line was disabled, and before it is going to be enabled.

- .did_interrupt() - Intended for multi-PHY devices with a shared IRQ line and used by phylib to discern which PHY from the package was the one that actually fired the interrupt.

- .handle_interrupt() - Completely overrides the default interrupt handling logic from phylib. The PHY driver is responsible for checking if any interrupt was fired by the respective PHY and choose accordingly if it's the one that should trigger the link state machine.

From my point of view, the interrupt handling in phylib has become somewhat confusing with all these callbacks that actually read the same PHY register - the interrupt status. A more streamlined approach would be to just move the responsibility to write an interrupt handler to the driver (as any other device driver does) and make .handle_interrupt() the only way to deal with interrupts.

Another advantage with this approach would be that phylib would gain support for shared IRQs between different PHY (not just multi-PHY devices), something which at the moment would require extending every PHY driver anyway in order to implement their .did_interrupt() callback and duplicate the same logic as in .ack_interrupt(). The disadvantage of making .did_interrupt() mandatory would be that we are slightly changing the semantics of the phylib API and that would increase confusion instead of reducing it.

What I am proposing is the following:

- As a first step, make the .ack_interrupt() callback optional so that we do not break any PHY driver amid the transition.

- Every PHY driver gains a .handle_interrupt() implementation that, for the most part, would look like below:

	irq_status = phy_read(phydev, INTR_STATUS);
	if (irq_status < 0) {
		phy_error(phydev);
		return IRQ_NONE;
	}

	if (!(irq_status & irq_mask))
		return IRQ_NONE;

	phy_trigger_machine(phydev);

	return IRQ_HANDLED;

- Remove each PHY driver's implementation of the .ack_interrupt() by actually taking care of quiescing any pending interrupts before enabling/after disabling the interrupt line.

- Finally, after all drivers have been ported, remove the .ack_interrupt() and .did_interrupt() callbacks from phy_driver.

This patch set is part 1 and it addresses the changes needed in phylib and 7 PHY drivers. The rest can be found on my Github branch here:
https://github.com/IoanaCiornei/linux/commits/phylib-shared-irq

I do not have access to most of these PHY's, therefore I Cc-ed the latest contributors to the individual PHY drivers in order to have access, hopefully, to more regression testing.

Changes in v2:
- Rework the .handle_interrupt() implementation for each driver so that only the enabled interrupts are taken into account when IRQ_NONE/IRQ_HANDLED it returned. The main idea is so that we avoid falsely blaming a device for triggering an interrupt when this is not the case.
The only devices for which I was unable to make this adjustment were the BCM8706, BCM8727, BCMAC131 and BCM5241 since I do not have access to their datasheets.
- I also updated the pseudo-code added in the cover-letter so that it's more clear how a .handle_interrupt() callback should look like.

Ioana Ciornei (19):
net: phy: export phy_error and phy_trigger_machine
net: phy: add a shutdown procedure
net: phy: make .ack_interrupt() optional
net: phy: at803x: implement generic .handle_interrupt() callback
net: phy: at803x: remove the use of .ack_interrupt()
net: phy: mscc: use phy_trigger_machine() to notify link change
net: phy: mscc: implement generic .handle_interrupt() callback
net: phy: mscc: remove the use of .ack_interrupt()
net: phy: aquantia: implement generic .handle_interrupt() callback
net: phy: aquantia: remove the use of .ack_interrupt()
net: phy: broadcom: implement generic .handle_interrupt() callback
net: phy: broadcom: remove use of ack_interrupt()
net: phy: cicada: implement the generic .handle_interrupt() callback
net: phy: cicada: remove the use of .ack_interrupt()
net: phy: davicom: implement generic .handle_interrupt() calback
net: phy: davicom: remove the use of .ack_interrupt()
net: phy: add genphy_handle_interrupt_no_ack()
net: phy: realtek: implement generic .handle_interrupt() callback
net: phy: realtek: remove the use of .ack_interrupt()

 drivers/net/phy/aquantia_main.c  |  59 +++++++++----
 drivers/net/phy/at803x.c         |  50 +++++++++--
 drivers/net/phy/bcm-cygnus.c     |   2 +-
 drivers/net/phy/bcm-phy-lib.c    |  49 ++++++++++-
 drivers/net/phy/bcm-phy-lib.h    |   1 +
 drivers/net/phy/bcm54140.c       |  46 +++++++---
 drivers/net/phy/bcm63xx.c        |  20 +++--
 drivers/net/phy/bcm87xx.c        |  50 ++++++-----
 drivers/net/phy/broadcom.c       |  70 +++++++++++-----
 drivers/net/phy/cicada.c         |  35 +++++++-
 drivers/net/phy/davicom.c        |  63 ++++++++++----
 drivers/net/phy/mscc/mscc_main.c |  70 ++++++++--------
 drivers/net/phy/phy.c            |   6 +-
 drivers/net/phy/phy_device.c     |  23 ++++-
 drivers/net/phy/realtek.c        | 140 +++++++++++++++++++++++++++----
 include/linux/phy.h              |   3 +
 16 files changed, 529 insertions(+), 158 deletions(-)
Cc Alexandru Ardelean <[email protected]>
Cc Andre Edich <[email protected]>
Cc Antoine Tenart <[email protected]>
Cc Baruch Siach <[email protected]>
Cc Christophe Leroy <[email protected]>
Cc Dan Murphy <[email protected]>
Cc Divya Koppera <[email protected]>
Cc Florian Fainelli <[email protected]>
Cc Hauke Mehrtens <[email protected]>
Cc Heiner Kallweit <[email protected]>
Cc Jerome Brunet <[email protected]>
Cc Kavya Sree Kotagiri <[email protected]>
Cc Linus Walleij <[email protected]>
Cc Marco Felsch <[email protected]>
Cc Marek Vasut <[email protected]>
Cc Martin Blumenstingl <[email protected]>
Cc Mathias Kresin <[email protected]>
Cc Maxim Kochetkov <[email protected]>
Cc Michael Walle <[email protected]>
Cc Neil Armstrong <[email protected]>
Cc Nisar Sayed <[email protected]>
Cc Oleksij Rempel <[email protected]>
Cc Philippe Schenker <[email protected]>
Cc Willy Liu <[email protected]>
Cc Yuiko Oshino <[email protected]>
Signature · 1 line
2.28.0