diff options
author | Robert P. J. Day <rpjday@crashcourse.ca> | 2018-12-26 07:35:23 -0500 |
---|---|---|
committer | David S. Miller <davem@davemloft.net> | 2018-12-27 19:29:31 -0500 |
commit | d8de01b763e0d8b3b418d3606d26f203983b6637 (patch) | |
tree | 72db14013226b36f980c3c01ff0c3aaa1e1355ae /include/linux/phy.h | |
parent | 40752b3eae29f8ca2378e978a02bd6dbeeb06d16 (diff) |
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>
Diffstat (limited to 'include/linux/phy.h')
-rw-r--r-- | include/linux/phy.h | 13 |
1 files changed, 8 insertions, 5 deletions
diff --git a/include/linux/phy.h b/include/linux/phy.h index da039f211c22..3b051f761450 100644 --- a/include/linux/phy.h +++ b/include/linux/phy.h | |||
@@ -1,6 +1,6 @@ | |||
1 | /* | 1 | /* |
2 | * Framework and drivers for configuring and reading different PHYs | 2 | * Framework and drivers for configuring and reading different PHYs |
3 | * Based on code in sungem_phy.c and gianfar_phy.c | 3 | * Based on code in sungem_phy.c and (long-removed) gianfar_phy.c |
4 | * | 4 | * |
5 | * Author: Andy Fleming | 5 | * Author: Andy Fleming |
6 | * | 6 | * |
@@ -110,9 +110,9 @@ typedef enum { | |||
110 | * @speeds: buffer to store supported speeds in. | 110 | * @speeds: buffer to store supported speeds in. |
111 | * @size: size of speeds buffer. | 111 | * @size: size of speeds buffer. |
112 | * | 112 | * |
113 | * Description: Returns the number of supported speeds, and | 113 | * Description: Returns the number of supported speeds, and fills |
114 | * fills the speeds * buffer with the supported speeds. If speeds buffer is | 114 | * the speeds buffer with the supported speeds. If speeds buffer is |
115 | * too small to contain * all currently supported speeds, will return as | 115 | * too small to contain all currently supported speeds, will return as |
116 | * many speeds as can fit. | 116 | * many speeds as can fit. |
117 | */ | 117 | */ |
118 | unsigned int phy_supported_speeds(struct phy_device *phy, | 118 | unsigned int phy_supported_speeds(struct phy_device *phy, |
@@ -120,7 +120,10 @@ unsigned int phy_supported_speeds(struct phy_device *phy, | |||
120 | unsigned int size); | 120 | unsigned int size); |
121 | 121 | ||
122 | /** | 122 | /** |
123 | * It maps 'enum phy_interface_t' found in include/linux/phy.h | 123 | * phy_modes - map phy_interface_t enum to device tree binding of phy-mode |
124 | * @interface: enum phy_interface_t value | ||
125 | * | ||
126 | * Description: maps 'enum phy_interface_t' defined in this file | ||
124 | * into the device tree binding of 'phy-mode', so that Ethernet | 127 | * into the device tree binding of 'phy-mode', so that Ethernet |
125 | * device driver can get phy interface from device tree. | 128 | * device driver can get phy interface from device tree. |
126 | */ | 129 | */ |