9ns: Support rename
[akaros.git] / kern / drivers / net / linux_mii.h
1 /*
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  */
7
8 #pragma once
9
10 #include "linux_uapi_mii.h"
11
12 struct ethtool_cmd;
13
14 struct mii_if_info {
15         int phy_id;
16         int advertising;
17         int phy_id_mask;
18         int reg_num_mask;
19
20         unsigned int full_duplex : 1;   /* is full duplex? */
21         unsigned int force_media : 1;   /* is autoneg. disabled? */
22         unsigned int supports_gmii : 1; /* are GMII registers supported? */
23
24         struct ether *dev;
25         int (*mdio_read) (struct ether *dev, int phy_id, int location);
26         void (*mdio_write) (struct ether *dev, int phy_id, int location,
27                             int val);
28 };
29
30 extern int mii_link_ok (struct mii_if_info *mii);
31 extern int mii_nway_restart (struct mii_if_info *mii);
32 #if 0 // AKAROS_PORT
33 extern int mii_ethtool_gset(struct mii_if_info *mii, struct ethtool_cmd *ecmd);
34 extern void mii_ethtool_get_link_ksettings(
35         struct mii_if_info *mii, struct ethtool_link_ksettings *cmd);
36 extern int mii_ethtool_sset(struct mii_if_info *mii, struct ethtool_cmd *ecmd);
37 extern int mii_ethtool_set_link_ksettings(
38         struct mii_if_info *mii, const struct ethtool_link_ksettings *cmd);
39 #endif
40 extern int mii_check_gmii_support(struct mii_if_info *mii);
41 extern void mii_check_link (struct mii_if_info *mii);
42 extern unsigned int mii_check_media (struct mii_if_info *mii,
43                                      unsigned int ok_to_print,
44                                      unsigned int init_media);
45 extern int generic_mii_ioctl(struct mii_if_info *mii_if,
46                              struct mii_ioctl_data *mii_data, int cmd,
47                              unsigned int *duplex_changed);
48
49
50 #if 0 // AKAROS_PORT
51 static inline struct mii_ioctl_data *if_mii(struct ifreq *rq)
52 {
53         return (struct mii_ioctl_data *) &rq->ifr_ifru;
54 }
55 #endif
56
57 /**
58  * mii_nway_result
59  * @negotiated: value of MII ANAR and'd with ANLPAR
60  *
61  * Given a set of MII abilities, check each bit and returns the
62  * currently supported media, in the priority order defined by
63  * IEEE 802.3u.  We use LPA_xxx constants but note this is not the
64  * value of LPA solely, as described above.
65  *
66  * The one exception to IEEE 802.3u is that 100baseT4 is placed
67  * between 100T-full and 100T-half.  If your phy does not support
68  * 100T4 this is fine.  If your phy places 100T4 elsewhere in the
69  * priority order, you will need to roll your own function.
70  */
71 static inline unsigned int mii_nway_result (unsigned int negotiated)
72 {
73         unsigned int ret;
74
75         if (negotiated & LPA_100FULL)
76                 ret = LPA_100FULL;
77         else if (negotiated & LPA_100BASE4)
78                 ret = LPA_100BASE4;
79         else if (negotiated & LPA_100HALF)
80                 ret = LPA_100HALF;
81         else if (negotiated & LPA_10FULL)
82                 ret = LPA_10FULL;
83         else
84                 ret = LPA_10HALF;
85
86         return ret;
87 }
88
89 /**
90  * mii_duplex
91  * @duplex_lock: Non-zero if duplex is locked at full
92  * @negotiated: value of MII ANAR and'd with ANLPAR
93  *
94  * A small helper function for a common case.  Returns one
95  * if the media is operating or locked at full duplex, and
96  * returns zero otherwise.
97  */
98 static inline unsigned int mii_duplex (unsigned int duplex_lock,
99                                        unsigned int negotiated)
100 {
101         if (duplex_lock)
102                 return 1;
103         if (mii_nway_result(negotiated) & LPA_DUPLEX)
104                 return 1;
105         return 0;
106 }
107
108 /**
109  * ethtool_adv_to_mii_adv_t
110  * @ethadv: the ethtool advertisement settings
111  *
112  * A small helper function that translates ethtool advertisement
113  * settings to phy autonegotiation advertisements for the
114  * MII_ADVERTISE register.
115  */
116 static inline uint32_t ethtool_adv_to_mii_adv_t(uint32_t ethadv)
117 {
118         uint32_t result = 0;
119
120         if (ethadv & ADVERTISED_10baseT_Half)
121                 result |= ADVERTISE_10HALF;
122         if (ethadv & ADVERTISED_10baseT_Full)
123                 result |= ADVERTISE_10FULL;
124         if (ethadv & ADVERTISED_100baseT_Half)
125                 result |= ADVERTISE_100HALF;
126         if (ethadv & ADVERTISED_100baseT_Full)
127                 result |= ADVERTISE_100FULL;
128         if (ethadv & ADVERTISED_Pause)
129                 result |= ADVERTISE_PAUSE_CAP;
130         if (ethadv & ADVERTISED_Asym_Pause)
131                 result |= ADVERTISE_PAUSE_ASYM;
132
133         return result;
134 }
135
136 /**
137  * mii_adv_to_ethtool_adv_t
138  * @adv: value of the MII_ADVERTISE register
139  *
140  * A small helper function that translates MII_ADVERTISE bits
141  * to ethtool advertisement settings.
142  */
143 static inline uint32_t mii_adv_to_ethtool_adv_t(uint32_t adv)
144 {
145         uint32_t result = 0;
146
147         if (adv & ADVERTISE_10HALF)
148                 result |= ADVERTISED_10baseT_Half;
149         if (adv & ADVERTISE_10FULL)
150                 result |= ADVERTISED_10baseT_Full;
151         if (adv & ADVERTISE_100HALF)
152                 result |= ADVERTISED_100baseT_Half;
153         if (adv & ADVERTISE_100FULL)
154                 result |= ADVERTISED_100baseT_Full;
155         if (adv & ADVERTISE_PAUSE_CAP)
156                 result |= ADVERTISED_Pause;
157         if (adv & ADVERTISE_PAUSE_ASYM)
158                 result |= ADVERTISED_Asym_Pause;
159
160         return result;
161 }
162
163 /**
164  * ethtool_adv_to_mii_ctrl1000_t
165  * @ethadv: the ethtool advertisement settings
166  *
167  * A small helper function that translates ethtool advertisement
168  * settings to phy autonegotiation advertisements for the
169  * MII_CTRL1000 register when in 1000T mode.
170  */
171 static inline uint32_t ethtool_adv_to_mii_ctrl1000_t(uint32_t ethadv)
172 {
173         uint32_t result = 0;
174
175         if (ethadv & ADVERTISED_1000baseT_Half)
176                 result |= ADVERTISE_1000HALF;
177         if (ethadv & ADVERTISED_1000baseT_Full)
178                 result |= ADVERTISE_1000FULL;
179
180         return result;
181 }
182
183 /**
184  * mii_ctrl1000_to_ethtool_adv_t
185  * @adv: value of the MII_CTRL1000 register
186  *
187  * A small helper function that translates MII_CTRL1000
188  * bits, when in 1000Base-T mode, to ethtool
189  * advertisement settings.
190  */
191 static inline uint32_t mii_ctrl1000_to_ethtool_adv_t(uint32_t adv)
192 {
193         uint32_t result = 0;
194
195         if (adv & ADVERTISE_1000HALF)
196                 result |= ADVERTISED_1000baseT_Half;
197         if (adv & ADVERTISE_1000FULL)
198                 result |= ADVERTISED_1000baseT_Full;
199
200         return result;
201 }
202
203 /**
204  * mii_lpa_to_ethtool_lpa_t
205  * @adv: value of the MII_LPA register
206  *
207  * A small helper function that translates MII_LPA
208  * bits, when in 1000Base-T mode, to ethtool
209  * LP advertisement settings.
210  */
211 static inline uint32_t mii_lpa_to_ethtool_lpa_t(uint32_t lpa)
212 {
213         uint32_t result = 0;
214
215         if (lpa & LPA_LPACK)
216                 result |= ADVERTISED_Autoneg;
217
218         return result | mii_adv_to_ethtool_adv_t(lpa);
219 }
220
221 /**
222  * mii_stat1000_to_ethtool_lpa_t
223  * @adv: value of the MII_STAT1000 register
224  *
225  * A small helper function that translates MII_STAT1000
226  * bits, when in 1000Base-T mode, to ethtool
227  * advertisement settings.
228  */
229 static inline uint32_t mii_stat1000_to_ethtool_lpa_t(uint32_t lpa)
230 {
231         uint32_t result = 0;
232
233         if (lpa & LPA_1000HALF)
234                 result |= ADVERTISED_1000baseT_Half;
235         if (lpa & LPA_1000FULL)
236                 result |= ADVERTISED_1000baseT_Full;
237
238         return result;
239 }
240
241 /**
242  * ethtool_adv_to_mii_adv_x
243  * @ethadv: the ethtool advertisement settings
244  *
245  * A small helper function that translates ethtool advertisement
246  * settings to phy autonegotiation advertisements for the
247  * MII_CTRL1000 register when in 1000Base-X mode.
248  */
249 static inline uint32_t ethtool_adv_to_mii_adv_x(uint32_t ethadv)
250 {
251         uint32_t result = 0;
252
253         if (ethadv & ADVERTISED_1000baseT_Half)
254                 result |= ADVERTISE_1000XHALF;
255         if (ethadv & ADVERTISED_1000baseT_Full)
256                 result |= ADVERTISE_1000XFULL;
257         if (ethadv & ADVERTISED_Pause)
258                 result |= ADVERTISE_1000XPAUSE;
259         if (ethadv & ADVERTISED_Asym_Pause)
260                 result |= ADVERTISE_1000XPSE_ASYM;
261
262         return result;
263 }
264
265 /**
266  * mii_adv_to_ethtool_adv_x
267  * @adv: value of the MII_CTRL1000 register
268  *
269  * A small helper function that translates MII_CTRL1000
270  * bits, when in 1000Base-X mode, to ethtool
271  * advertisement settings.
272  */
273 static inline uint32_t mii_adv_to_ethtool_adv_x(uint32_t adv)
274 {
275         uint32_t result = 0;
276
277         if (adv & ADVERTISE_1000XHALF)
278                 result |= ADVERTISED_1000baseT_Half;
279         if (adv & ADVERTISE_1000XFULL)
280                 result |= ADVERTISED_1000baseT_Full;
281         if (adv & ADVERTISE_1000XPAUSE)
282                 result |= ADVERTISED_Pause;
283         if (adv & ADVERTISE_1000XPSE_ASYM)
284                 result |= ADVERTISED_Asym_Pause;
285
286         return result;
287 }
288
289 /**
290  * mii_lpa_to_ethtool_lpa_x
291  * @adv: value of the MII_LPA register
292  *
293  * A small helper function that translates MII_LPA
294  * bits, when in 1000Base-X mode, to ethtool
295  * LP advertisement settings.
296  */
297 static inline uint32_t mii_lpa_to_ethtool_lpa_x(uint32_t lpa)
298 {
299         uint32_t result = 0;
300
301         if (lpa & LPA_LPACK)
302                 result |= ADVERTISED_Autoneg;
303
304         return result | mii_adv_to_ethtool_adv_x(lpa);
305 }
306
307 /**
308  * mii_advertise_flowctrl - get flow control advertisement flags
309  * @cap: Flow control capabilities (FLOW_CTRL_RX, FLOW_CTRL_TX or both)
310  */
311 static inline uint16_t mii_advertise_flowctrl(int cap)
312 {
313         uint16_t adv = 0;
314
315         if (cap & FLOW_CTRL_RX)
316                 adv = ADVERTISE_PAUSE_CAP | ADVERTISE_PAUSE_ASYM;
317         if (cap & FLOW_CTRL_TX)
318                 adv ^= ADVERTISE_PAUSE_ASYM;
319
320         return adv;
321 }
322
323 /**
324  * mii_resolve_flowctrl_fdx
325  * @lcladv: value of MII ADVERTISE register
326  * @rmtadv: value of MII LPA register
327  *
328  * Resolve full duplex flow control as per IEEE 802.3-2005 table 28B-3
329  */
330 static inline uint8_t mii_resolve_flowctrl_fdx(uint16_t lcladv,
331                                                uint16_t rmtadv)
332 {
333         uint8_t cap = 0;
334
335         if (lcladv & rmtadv & ADVERTISE_PAUSE_CAP) {
336                 cap = FLOW_CTRL_TX | FLOW_CTRL_RX;
337         } else if (lcladv & rmtadv & ADVERTISE_PAUSE_ASYM) {
338                 if (lcladv & ADVERTISE_PAUSE_CAP)
339                         cap = FLOW_CTRL_RX;
340                 else if (rmtadv & ADVERTISE_PAUSE_CAP)
341                         cap = FLOW_CTRL_TX;
342         }
343
344         return cap;
345 }