From: Heiner Kallweit <hkallweit1@gmail.com>
To: Andrew Lunn <andrew@lunn.ch>,
Florian Fainelli <f.fainelli@gmail.com>,
David Miller <davem@davemloft.net>
Cc: "netdev@vger.kernel.org" <netdev@vger.kernel.org>
Subject: [PATCH net-next] Documentation: net: phy: reflect latest changes to phylib API
Date: Fri, 25 Jan 2019 21:08:24 +0100 [thread overview]
Message-ID: <27b5d4a5-4939-54d9-baed-6dd2ae743511@gmail.com> (raw)
Recent changes to the phylib API
- removed phy_stop_interrupts
- replaced phy_start_interrupts with phy_request_interrupt
- moved some functionality from phy_connect() and phy_disconnect()
to phy_start() and phy_stop() respectively.
Reflect these changes in the documentation.
Signed-off-by: Heiner Kallweit <hkallweit1@gmail.com>
---
Documentation/networking/phy.txt | 18 ++++++++++--------
1 file changed, 10 insertions(+), 8 deletions(-)
diff --git a/Documentation/networking/phy.txt b/Documentation/networking/phy.txt
index bdec0f700..7ecba4fd6 100644
--- a/Documentation/networking/phy.txt
+++ b/Documentation/networking/phy.txt
@@ -210,12 +210,16 @@ Letting the PHY Abstraction Layer do Everything
Lastly, once the controller is ready to handle network traffic, you call
phy_start(phydev). This tells the PAL that you are ready, and configures the
- PHY to connect to the network. If you want to handle your own interrupts,
- just set phydev->irq to PHY_IGNORE_INTERRUPT before you call phy_start.
- Similarly, if you don't want to use interrupts, set phydev->irq to PHY_POLL.
+ PHY to connect to the network. If the MAC interrupt of your network driver
+ also handles PHY status changes, just set phydev->irq to PHY_IGNORE_INTERRUPT
+ before you call phy_start and use phy_mac_interrupt() from the network
+ driver. If you don't want to use interrupts, set phydev->irq to PHY_POLL.
+ phy_start() enables the PHY interrupts (if applicable) and starts the
+ phylib state machine.
When you want to disconnect from the network (even if just briefly), you call
- phy_stop(phydev).
+ phy_stop(phydev). This function also stops the phylib state machine and
+ disables PHY interrupts.
Pause frames / flow control
@@ -271,11 +275,9 @@ Doing it all yourself
A convenience function to print out the PHY status neatly.
- int phy_start_interrupts(struct phy_device *phydev);
- int phy_stop_interrupts(struct phy_device *phydev);
+ void phy_request_interrupt(struct phy_device *phydev);
- Requests the IRQ for the PHY interrupts, then enables them for
- start, or disables then frees them for stop.
+ Requests the IRQ for the PHY interrupts.
struct phy_device * phy_attach(struct net_device *dev, const char *phy_id,
phy_interface_t interface);
--
2.20.1
next reply other threads:[~2019-01-25 20:08 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-01-25 20:08 Heiner Kallweit [this message]
2019-01-26 5:22 ` [PATCH net-next] Documentation: net: phy: reflect latest changes to phylib API David Miller
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=27b5d4a5-4939-54d9-baed-6dd2ae743511@gmail.com \
--to=hkallweit1@gmail.com \
--cc=andrew@lunn.ch \
--cc=davem@davemloft.net \
--cc=f.fainelli@gmail.com \
--cc=netdev@vger.kernel.org \
/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