diff options
author | Florian Fainelli <f.fainelli@gmail.com> | 2016-11-27 21:45:12 -0500 |
---|---|---|
committer | David S. Miller <davem@davemloft.net> | 2016-11-28 16:07:42 -0500 |
commit | 527fd70e26e68d65a47e17e71f637dc42dbd26cc (patch) | |
tree | 88e2716c6b64f337b5b0cab5f03be943ab967930 /Documentation/networking | |
parent | 5edef2f288bcfb8c4d72105ea5b09a760341a946 (diff) |
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: Martin Blumenstingl <martin.blumenstingl@googlemail.com>
Signed-off-by: Florian Fainelli <f.fainelli@gmail.com>
Signed-off-by: David S. Miller <davem@davemloft.net>
Diffstat (limited to 'Documentation/networking')
-rw-r--r-- | Documentation/networking/phy.txt | 35 |
1 files changed, 2 insertions, 33 deletions
diff --git a/Documentation/networking/phy.txt b/Documentation/networking/phy.txt index 7ab9404a8412..4b25c0f24201 100644 --- a/Documentation/networking/phy.txt +++ b/Documentation/networking/phy.txt | |||
@@ -251,39 +251,8 @@ Writing a PHY driver | |||
251 | PHY_BASIC_FEATURES, but you can look in include/mii.h for other | 251 | PHY_BASIC_FEATURES, but you can look in include/mii.h for other |
252 | features. | 252 | features. |
253 | 253 | ||
254 | Each driver consists of a number of function pointers: | 254 | Each driver consists of a number of function pointers, documented |
255 | 255 | in include/linux/phy.h under the phy_driver structure. | |
256 | soft_reset: perform a PHY software reset | ||
257 | config_init: configures PHY into a sane state after a reset. | ||
258 | For instance, a Davicom PHY requires descrambling disabled. | ||
259 | probe: Allocate phy->priv, optionally refuse to bind. | ||
260 | PHY may not have been reset or had fixups run yet. | ||
261 | suspend/resume: power management | ||
262 | config_aneg: Changes the speed/duplex/negotiation settings | ||
263 | aneg_done: Determines the auto-negotiation result | ||
264 | read_status: Reads the current speed/duplex/negotiation settings | ||
265 | ack_interrupt: Clear a pending interrupt | ||
266 | did_interrupt: Checks if the PHY generated an interrupt | ||
267 | config_intr: Enable or disable interrupts | ||
268 | remove: Does any driver take-down | ||
269 | ts_info: Queries about the HW timestamping status | ||
270 | match_phy_device: used for Clause 45 capable PHYs to match devices | ||
271 | in package and ensure they are compatible | ||
272 | hwtstamp: Set the PHY HW timestamping configuration | ||
273 | rxtstamp: Requests a receive timestamp at the PHY level for a 'skb' | ||
274 | txtsamp: Requests a transmit timestamp at the PHY level for a 'skb' | ||
275 | set_wol: Enable Wake-on-LAN at the PHY level | ||
276 | get_wol: Get the Wake-on-LAN status at the PHY level | ||
277 | link_change_notify: called to inform the core is about to change the | ||
278 | link state, can be used to work around bogus PHY between state changes | ||
279 | read_mmd_indirect: Read PHY MMD indirect register | ||
280 | write_mmd_indirect: Write PHY MMD indirect register | ||
281 | module_info: Get the size and type of an EEPROM contained in an plug-in | ||
282 | module | ||
283 | module_eeprom: Get EEPROM information of a plug-in module | ||
284 | get_sset_count: Get number of strings sets that get_strings will count | ||
285 | get_strings: Get strings from requested objects (statistics) | ||
286 | get_stats: Get the extended statistics from the PHY device | ||
287 | 256 | ||
288 | Of these, only config_aneg and read_status are required to be | 257 | Of these, only config_aneg and read_status are required to be |
289 | assigned by the driver code. The rest are optional. Also, it is | 258 | assigned by the driver code. The rest are optional. Also, it is |