phy.h: fix obvious errors in doc and kerneldoc content

1) note that gianfar_phy.c was removed years ago
 2) fix obvious copy and paste error in regular doc
 3) change regular doc into kerneldoc for phy_modes()

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: David S. Miller <davem@davemloft.net>
This commit is contained in:
Robert P. J. Day 2018-12-26 06:35:23 -06:00 committed by David S. Miller
parent 40752b3eae
commit d8de01b763

View File

@ -1,6 +1,6 @@
/* /*
* Framework and drivers for configuring and reading different PHYs * Framework and drivers for configuring and reading different PHYs
* Based on code in sungem_phy.c and gianfar_phy.c * Based on code in sungem_phy.c and (long-removed) gianfar_phy.c
* *
* Author: Andy Fleming * Author: Andy Fleming
* *
@ -110,9 +110,9 @@ typedef enum {
* @speeds: buffer to store supported speeds in. * @speeds: buffer to store supported speeds in.
* @size: size of speeds buffer. * @size: size of speeds buffer.
* *
* Description: Returns the number of supported speeds, and * Description: Returns the number of supported speeds, and fills
* fills the speeds * buffer with the supported speeds. If speeds buffer is * the speeds buffer with the supported speeds. If speeds buffer is
* too small to contain * all currently supported speeds, will return as * too small to contain all currently supported speeds, will return as
* many speeds as can fit. * many speeds as can fit.
*/ */
unsigned int phy_supported_speeds(struct phy_device *phy, unsigned int phy_supported_speeds(struct phy_device *phy,
@ -120,7 +120,10 @@ unsigned int phy_supported_speeds(struct phy_device *phy,
unsigned int size); unsigned int size);
/** /**
* It maps 'enum phy_interface_t' found in include/linux/phy.h * phy_modes - map phy_interface_t enum to device tree binding of phy-mode
* @interface: enum phy_interface_t value
*
* Description: maps 'enum phy_interface_t' defined in this file
* into the device tree binding of 'phy-mode', so that Ethernet * into the device tree binding of 'phy-mode', so that Ethernet
* device driver can get phy interface from device tree. * device driver can get phy interface from device tree.
*/ */