blob: 47492c9631b3826fb8a52a53f6dbbdcbb7bbe2e3 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * linux/mii.h: definitions for MII-compatible transceivers
3 * Originally drivers/net/sunhme.h.
4 *
5 * Copyright (C) 1996, 1999, 2001 David S. Miller (davem@redhat.com)
6 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07007#ifndef __LINUX_MII_H__
8#define __LINUX_MII_H__
9
David Woodhousec3ce7e22006-04-29 01:53:47 +010010
11#include <linux/if.h>
David Howells607ca462012-10-13 10:46:48 +010012#include <uapi/linux/mii.h>
David Woodhousec3ce7e22006-04-29 01:53:47 +010013
14struct ethtool_cmd;
15
Linus Torvalds1da177e2005-04-16 15:20:36 -070016struct mii_if_info {
17 int phy_id;
18 int advertising;
19 int phy_id_mask;
20 int reg_num_mask;
21
22 unsigned int full_duplex : 1; /* is full duplex? */
23 unsigned int force_media : 1; /* is autoneg. disabled? */
24 unsigned int supports_gmii : 1; /* are GMII registers supported? */
25
26 struct net_device *dev;
27 int (*mdio_read) (struct net_device *dev, int phy_id, int location);
28 void (*mdio_write) (struct net_device *dev, int phy_id, int location, int val);
29};
30
Linus Torvalds1da177e2005-04-16 15:20:36 -070031extern int mii_link_ok (struct mii_if_info *mii);
32extern int mii_nway_restart (struct mii_if_info *mii);
33extern int mii_ethtool_gset(struct mii_if_info *mii, struct ethtool_cmd *ecmd);
34extern int mii_ethtool_sset(struct mii_if_info *mii, struct ethtool_cmd *ecmd);
Dale Farnsworth43ec6e92005-08-23 10:30:29 -070035extern int mii_check_gmii_support(struct mii_if_info *mii);
Linus Torvalds1da177e2005-04-16 15:20:36 -070036extern void mii_check_link (struct mii_if_info *mii);
37extern unsigned int mii_check_media (struct mii_if_info *mii,
38 unsigned int ok_to_print,
39 unsigned int init_media);
40extern int generic_mii_ioctl(struct mii_if_info *mii_if,
Mark Einonc44f7eb2011-08-31 23:22:16 +000041 struct mii_ioctl_data *mii_data, int cmd,
Linus Torvalds1da177e2005-04-16 15:20:36 -070042 unsigned int *duplex_changed);
43
44
Linus Torvalds1da177e2005-04-16 15:20:36 -070045static inline struct mii_ioctl_data *if_mii(struct ifreq *rq)
46{
47 return (struct mii_ioctl_data *) &rq->ifr_ifru;
48}
49
Linus Torvalds1da177e2005-04-16 15:20:36 -070050/**
51 * mii_nway_result
52 * @negotiated: value of MII ANAR and'd with ANLPAR
53 *
54 * Given a set of MII abilities, check each bit and returns the
55 * currently supported media, in the priority order defined by
56 * IEEE 802.3u. We use LPA_xxx constants but note this is not the
57 * value of LPA solely, as described above.
58 *
59 * The one exception to IEEE 802.3u is that 100baseT4 is placed
60 * between 100T-full and 100T-half. If your phy does not support
61 * 100T4 this is fine. If your phy places 100T4 elsewhere in the
62 * priority order, you will need to roll your own function.
63 */
64static inline unsigned int mii_nway_result (unsigned int negotiated)
65{
66 unsigned int ret;
67
68 if (negotiated & LPA_100FULL)
69 ret = LPA_100FULL;
70 else if (negotiated & LPA_100BASE4)
71 ret = LPA_100BASE4;
72 else if (negotiated & LPA_100HALF)
73 ret = LPA_100HALF;
74 else if (negotiated & LPA_10FULL)
75 ret = LPA_10FULL;
76 else
77 ret = LPA_10HALF;
78
79 return ret;
80}
81
82/**
83 * mii_duplex
84 * @duplex_lock: Non-zero if duplex is locked at full
85 * @negotiated: value of MII ANAR and'd with ANLPAR
86 *
87 * A small helper function for a common case. Returns one
88 * if the media is operating or locked at full duplex, and
89 * returns zero otherwise.
90 */
91static inline unsigned int mii_duplex (unsigned int duplex_lock,
92 unsigned int negotiated)
93{
94 if (duplex_lock)
95 return 1;
96 if (mii_nway_result(negotiated) & LPA_DUPLEX)
97 return 1;
98 return 0;
99}
100
Steve Glendinningbc02ff92008-12-16 02:00:48 -0800101/**
Matt Carlson37f07022011-11-17 14:30:55 +0000102 * ethtool_adv_to_mii_adv_t
Matt Carlson28011cf2011-11-16 18:36:59 -0500103 * @ethadv: the ethtool advertisement settings
104 *
105 * A small helper function that translates ethtool advertisement
106 * settings to phy autonegotiation advertisements for the
107 * MII_ADVERTISE register.
108 */
Matt Carlson37f07022011-11-17 14:30:55 +0000109static inline u32 ethtool_adv_to_mii_adv_t(u32 ethadv)
Matt Carlson28011cf2011-11-16 18:36:59 -0500110{
111 u32 result = 0;
112
113 if (ethadv & ADVERTISED_10baseT_Half)
114 result |= ADVERTISE_10HALF;
115 if (ethadv & ADVERTISED_10baseT_Full)
116 result |= ADVERTISE_10FULL;
117 if (ethadv & ADVERTISED_100baseT_Half)
118 result |= ADVERTISE_100HALF;
119 if (ethadv & ADVERTISED_100baseT_Full)
120 result |= ADVERTISE_100FULL;
121 if (ethadv & ADVERTISED_Pause)
122 result |= ADVERTISE_PAUSE_CAP;
123 if (ethadv & ADVERTISED_Asym_Pause)
124 result |= ADVERTISE_PAUSE_ASYM;
125
126 return result;
127}
128
129/**
Matt Carlson37f07022011-11-17 14:30:55 +0000130 * mii_adv_to_ethtool_adv_t
Matt Carlson28011cf2011-11-16 18:36:59 -0500131 * @adv: value of the MII_ADVERTISE register
132 *
133 * A small helper function that translates MII_ADVERTISE bits
134 * to ethtool advertisement settings.
135 */
Matt Carlson37f07022011-11-17 14:30:55 +0000136static inline u32 mii_adv_to_ethtool_adv_t(u32 adv)
Matt Carlson28011cf2011-11-16 18:36:59 -0500137{
138 u32 result = 0;
139
140 if (adv & ADVERTISE_10HALF)
141 result |= ADVERTISED_10baseT_Half;
142 if (adv & ADVERTISE_10FULL)
143 result |= ADVERTISED_10baseT_Full;
144 if (adv & ADVERTISE_100HALF)
145 result |= ADVERTISED_100baseT_Half;
146 if (adv & ADVERTISE_100FULL)
147 result |= ADVERTISED_100baseT_Full;
148 if (adv & ADVERTISE_PAUSE_CAP)
149 result |= ADVERTISED_Pause;
150 if (adv & ADVERTISE_PAUSE_ASYM)
151 result |= ADVERTISED_Asym_Pause;
152
153 return result;
154}
155
156/**
Matt Carlson37f07022011-11-17 14:30:55 +0000157 * ethtool_adv_to_mii_ctrl1000_t
Matt Carlson28011cf2011-11-16 18:36:59 -0500158 * @ethadv: the ethtool advertisement settings
159 *
160 * A small helper function that translates ethtool advertisement
161 * settings to phy autonegotiation advertisements for the
162 * MII_CTRL1000 register when in 1000T mode.
163 */
Matt Carlson37f07022011-11-17 14:30:55 +0000164static inline u32 ethtool_adv_to_mii_ctrl1000_t(u32 ethadv)
Matt Carlson28011cf2011-11-16 18:36:59 -0500165{
166 u32 result = 0;
167
168 if (ethadv & ADVERTISED_1000baseT_Half)
169 result |= ADVERTISE_1000HALF;
170 if (ethadv & ADVERTISED_1000baseT_Full)
171 result |= ADVERTISE_1000FULL;
172
173 return result;
174}
175
176/**
Matt Carlson37f07022011-11-17 14:30:55 +0000177 * mii_ctrl1000_to_ethtool_adv_t
Matt Carlson28011cf2011-11-16 18:36:59 -0500178 * @adv: value of the MII_CTRL1000 register
179 *
180 * A small helper function that translates MII_CTRL1000
181 * bits, when in 1000Base-T mode, to ethtool
182 * advertisement settings.
183 */
Matt Carlson37f07022011-11-17 14:30:55 +0000184static inline u32 mii_ctrl1000_to_ethtool_adv_t(u32 adv)
Matt Carlson28011cf2011-11-16 18:36:59 -0500185{
186 u32 result = 0;
187
188 if (adv & ADVERTISE_1000HALF)
189 result |= ADVERTISED_1000baseT_Half;
190 if (adv & ADVERTISE_1000FULL)
191 result |= ADVERTISED_1000baseT_Full;
192
193 return result;
194}
195
Matt Carlson37f07022011-11-17 14:30:55 +0000196/**
197 * mii_lpa_to_ethtool_lpa_t
198 * @adv: value of the MII_LPA register
199 *
200 * A small helper function that translates MII_LPA
201 * bits, when in 1000Base-T mode, to ethtool
202 * LP advertisement settings.
203 */
204static inline u32 mii_lpa_to_ethtool_lpa_t(u32 lpa)
205{
206 u32 result = 0;
207
208 if (lpa & LPA_LPACK)
209 result |= ADVERTISED_Autoneg;
210
211 return result | mii_adv_to_ethtool_adv_t(lpa);
212}
Matt Carlson28011cf2011-11-16 18:36:59 -0500213
214/**
Matt Carlson37f07022011-11-17 14:30:55 +0000215 * mii_stat1000_to_ethtool_lpa_t
Matt Carlson28011cf2011-11-16 18:36:59 -0500216 * @adv: value of the MII_STAT1000 register
217 *
218 * A small helper function that translates MII_STAT1000
219 * bits, when in 1000Base-T mode, to ethtool
220 * advertisement settings.
221 */
Matt Carlson37f07022011-11-17 14:30:55 +0000222static inline u32 mii_stat1000_to_ethtool_lpa_t(u32 lpa)
Matt Carlson28011cf2011-11-16 18:36:59 -0500223{
224 u32 result = 0;
225
226 if (lpa & LPA_1000HALF)
227 result |= ADVERTISED_1000baseT_Half;
228 if (lpa & LPA_1000FULL)
229 result |= ADVERTISED_1000baseT_Full;
230
231 return result;
232}
233
234/**
Matt Carlson37f07022011-11-17 14:30:55 +0000235 * ethtool_adv_to_mii_adv_x
Matt Carlson28011cf2011-11-16 18:36:59 -0500236 * @ethadv: the ethtool advertisement settings
237 *
238 * A small helper function that translates ethtool advertisement
239 * settings to phy autonegotiation advertisements for the
240 * MII_CTRL1000 register when in 1000Base-X mode.
241 */
Matt Carlson37f07022011-11-17 14:30:55 +0000242static inline u32 ethtool_adv_to_mii_adv_x(u32 ethadv)
Matt Carlson28011cf2011-11-16 18:36:59 -0500243{
244 u32 result = 0;
245
246 if (ethadv & ADVERTISED_1000baseT_Half)
247 result |= ADVERTISE_1000XHALF;
248 if (ethadv & ADVERTISED_1000baseT_Full)
249 result |= ADVERTISE_1000XFULL;
250 if (ethadv & ADVERTISED_Pause)
251 result |= ADVERTISE_1000XPAUSE;
252 if (ethadv & ADVERTISED_Asym_Pause)
253 result |= ADVERTISE_1000XPSE_ASYM;
254
255 return result;
256}
257
258/**
Matt Carlson37f07022011-11-17 14:30:55 +0000259 * mii_adv_to_ethtool_adv_x
Matt Carlson28011cf2011-11-16 18:36:59 -0500260 * @adv: value of the MII_CTRL1000 register
261 *
262 * A small helper function that translates MII_CTRL1000
263 * bits, when in 1000Base-X mode, to ethtool
264 * advertisement settings.
265 */
Matt Carlson37f07022011-11-17 14:30:55 +0000266static inline u32 mii_adv_to_ethtool_adv_x(u32 adv)
Matt Carlson28011cf2011-11-16 18:36:59 -0500267{
268 u32 result = 0;
269
270 if (adv & ADVERTISE_1000XHALF)
271 result |= ADVERTISED_1000baseT_Half;
272 if (adv & ADVERTISE_1000XFULL)
273 result |= ADVERTISED_1000baseT_Full;
274 if (adv & ADVERTISE_1000XPAUSE)
275 result |= ADVERTISED_Pause;
276 if (adv & ADVERTISE_1000XPSE_ASYM)
277 result |= ADVERTISED_Asym_Pause;
278
279 return result;
280}
281
282/**
Matt Carlson37f07022011-11-17 14:30:55 +0000283 * mii_lpa_to_ethtool_lpa_x
284 * @adv: value of the MII_LPA register
285 *
286 * A small helper function that translates MII_LPA
287 * bits, when in 1000Base-X mode, to ethtool
288 * LP advertisement settings.
289 */
290static inline u32 mii_lpa_to_ethtool_lpa_x(u32 lpa)
291{
292 u32 result = 0;
293
294 if (lpa & LPA_LPACK)
295 result |= ADVERTISED_Autoneg;
296
297 return result | mii_adv_to_ethtool_adv_x(lpa);
298}
299
300/**
Ben Hutchingsa8c30832009-04-29 08:19:03 +0000301 * mii_advertise_flowctrl - get flow control advertisement flags
302 * @cap: Flow control capabilities (FLOW_CTRL_RX, FLOW_CTRL_TX or both)
303 */
304static inline u16 mii_advertise_flowctrl(int cap)
305{
306 u16 adv = 0;
307
308 if (cap & FLOW_CTRL_RX)
309 adv = ADVERTISE_PAUSE_CAP | ADVERTISE_PAUSE_ASYM;
310 if (cap & FLOW_CTRL_TX)
311 adv ^= ADVERTISE_PAUSE_ASYM;
312
313 return adv;
314}
315
316/**
Steve Glendinningbc02ff92008-12-16 02:00:48 -0800317 * mii_resolve_flowctrl_fdx
318 * @lcladv: value of MII ADVERTISE register
319 * @rmtadv: value of MII LPA register
320 *
321 * Resolve full duplex flow control as per IEEE 802.3-2005 table 28B-3
322 */
323static inline u8 mii_resolve_flowctrl_fdx(u16 lcladv, u16 rmtadv)
324{
325 u8 cap = 0;
326
Ben Hutchings44c22ee2009-04-29 08:15:05 +0000327 if (lcladv & rmtadv & ADVERTISE_PAUSE_CAP) {
328 cap = FLOW_CTRL_TX | FLOW_CTRL_RX;
329 } else if (lcladv & rmtadv & ADVERTISE_PAUSE_ASYM) {
330 if (lcladv & ADVERTISE_PAUSE_CAP)
331 cap = FLOW_CTRL_RX;
332 else if (rmtadv & ADVERTISE_PAUSE_CAP)
Steve Glendinningbc02ff92008-12-16 02:00:48 -0800333 cap = FLOW_CTRL_TX;
334 }
335
336 return cap;
337}
338
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339#endif /* __LINUX_MII_H__ */