Commit 527fd70e authored by Florian Fainelli's avatar Florian Fainelli Committed by David S. Miller

Documentation: net: phy: remove description of function pointers

Remove the function pointers documentation which duplicates information
found in include/linux/phy.h. Maintaining documentation about two
different locations just does not work, but the code is less likely to
be outdated.
Reviewed-by: default avatarMartin Blumenstingl <martin.blumenstingl@googlemail.com>
Signed-off-by: default avatarFlorian Fainelli <f.fainelli@gmail.com>
Signed-off-by: default avatarDavid S. Miller <davem@davemloft.net>
parent 5edef2f2
...@@ -251,39 +251,8 @@ Writing a PHY driver ...@@ -251,39 +251,8 @@ Writing a PHY driver
PHY_BASIC_FEATURES, but you can look in include/mii.h for other PHY_BASIC_FEATURES, but you can look in include/mii.h for other
features. features.
Each driver consists of a number of function pointers: Each driver consists of a number of function pointers, documented
in include/linux/phy.h under the phy_driver structure.
soft_reset: perform a PHY software reset
config_init: configures PHY into a sane state after a reset.
For instance, a Davicom PHY requires descrambling disabled.
probe: Allocate phy->priv, optionally refuse to bind.
PHY may not have been reset or had fixups run yet.
suspend/resume: power management
config_aneg: Changes the speed/duplex/negotiation settings
aneg_done: Determines the auto-negotiation result
read_status: Reads the current speed/duplex/negotiation settings
ack_interrupt: Clear a pending interrupt
did_interrupt: Checks if the PHY generated an interrupt
config_intr: Enable or disable interrupts
remove: Does any driver take-down
ts_info: Queries about the HW timestamping status
match_phy_device: used for Clause 45 capable PHYs to match devices
in package and ensure they are compatible
hwtstamp: Set the PHY HW timestamping configuration
rxtstamp: Requests a receive timestamp at the PHY level for a 'skb'
txtsamp: Requests a transmit timestamp at the PHY level for a 'skb'
set_wol: Enable Wake-on-LAN at the PHY level
get_wol: Get the Wake-on-LAN status at the PHY level
link_change_notify: called to inform the core is about to change the
link state, can be used to work around bogus PHY between state changes
read_mmd_indirect: Read PHY MMD indirect register
write_mmd_indirect: Write PHY MMD indirect register
module_info: Get the size and type of an EEPROM contained in an plug-in
module
module_eeprom: Get EEPROM information of a plug-in module
get_sset_count: Get number of strings sets that get_strings will count
get_strings: Get strings from requested objects (statistics)
get_stats: Get the extended statistics from the PHY device
Of these, only config_aneg and read_status are required to be Of these, only config_aneg and read_status are required to be
assigned by the driver code. The rest are optional. Also, it is assigned by the driver code. The rest are optional. Also, it is
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment