ethtool/mdio: Report MDIO mode support and link partner advertising
[linux-2.6] / drivers / net / mdio.c
1 /*
2  * mdio.c: Generic support for MDIO-compatible transceivers
3  * Copyright 2006-2009 Solarflare Communications Inc.
4  *
5  * This program is free software; you can redistribute it and/or modify it
6  * under the terms of the GNU General Public License version 2 as published
7  * by the Free Software Foundation, incorporated herein by reference.
8  */
9
10 #include <linux/kernel.h>
11 #include <linux/capability.h>
12 #include <linux/errno.h>
13 #include <linux/ethtool.h>
14 #include <linux/mdio.h>
15 #include <linux/module.h>
16
17 /**
18  * mdio45_probe - probe for an MDIO (clause 45) device
19  * @mdio: MDIO interface
20  * @prtad: Expected PHY address
21  *
22  * This sets @prtad and @mmds in the MDIO interface if successful.
23  * Returns 0 on success, negative on error.
24  */
25 int mdio45_probe(struct mdio_if_info *mdio, int prtad)
26 {
27         int mmd, stat2, devs1, devs2;
28
29         /* Assume PHY must have at least one of PMA/PMD, WIS, PCS, PHY
30          * XS or DTE XS; give up if none is present. */
31         for (mmd = 1; mmd <= 5; mmd++) {
32                 /* Is this MMD present? */
33                 stat2 = mdio->mdio_read(mdio->dev, prtad, mmd, MDIO_STAT2);
34                 if (stat2 < 0 ||
35                     (stat2 & MDIO_STAT2_DEVPRST) != MDIO_STAT2_DEVPRST_VAL)
36                         continue;
37
38                 /* It should tell us about all the other MMDs */
39                 devs1 = mdio->mdio_read(mdio->dev, prtad, mmd, MDIO_DEVS1);
40                 devs2 = mdio->mdio_read(mdio->dev, prtad, mmd, MDIO_DEVS2);
41                 if (devs1 < 0 || devs2 < 0)
42                         continue;
43
44                 mdio->prtad = prtad;
45                 mdio->mmds = devs1 | (devs2 << 16);
46                 return 0;
47         }
48
49         return -ENODEV;
50 }
51 EXPORT_SYMBOL(mdio45_probe);
52
53 /**
54  * mdio_set_flag - set or clear flag in an MDIO register
55  * @mdio: MDIO interface
56  * @prtad: PHY address
57  * @devad: MMD address
58  * @addr: Register address
59  * @mask: Mask for flag (single bit set)
60  * @sense: New value of flag
61  *
62  * This debounces changes: it does not write the register if the flag
63  * already has the proper value.  Returns 0 on success, negative on error.
64  */
65 int mdio_set_flag(const struct mdio_if_info *mdio,
66                   int prtad, int devad, u16 addr, int mask,
67                   bool sense)
68 {
69         int old_val = mdio->mdio_read(mdio->dev, prtad, devad, addr);
70         int new_val;
71
72         if (old_val < 0)
73                 return old_val;
74         if (sense)
75                 new_val = old_val | mask;
76         else
77                 new_val = old_val & ~mask;
78         if (old_val == new_val)
79                 return 0;
80         return mdio->mdio_write(mdio->dev, prtad, devad, addr, new_val);
81 }
82 EXPORT_SYMBOL(mdio_set_flag);
83
84 /**
85  * mdio_link_ok - is link status up/OK
86  * @mdio: MDIO interface
87  * @mmd_mask: Mask for MMDs to check
88  *
89  * Returns 1 if the PHY reports link status up/OK, 0 otherwise.
90  * @mmd_mask is normally @mdio->mmds, but if loopback is enabled
91  * the MMDs being bypassed should be excluded from the mask.
92  */
93 int mdio45_links_ok(const struct mdio_if_info *mdio, u32 mmd_mask)
94 {
95         int devad, reg;
96
97         if (!mmd_mask) {
98                 /* Use absence of XGMII faults in lieu of link state */
99                 reg = mdio->mdio_read(mdio->dev, mdio->prtad,
100                                       MDIO_MMD_PHYXS, MDIO_STAT2);
101                 return reg >= 0 && !(reg & MDIO_STAT2_RXFAULT);
102         }
103
104         for (devad = 0; mmd_mask; devad++) {
105                 if (mmd_mask & (1 << devad)) {
106                         mmd_mask &= ~(1 << devad);
107
108                         /* Read twice because link state is latched and a
109                          * read moves the current state into the register */
110                         mdio->mdio_read(mdio->dev, mdio->prtad,
111                                         devad, MDIO_STAT1);
112                         reg = mdio->mdio_read(mdio->dev, mdio->prtad,
113                                               devad, MDIO_STAT1);
114                         if (reg < 0 || !(reg & MDIO_STAT1_LSTATUS))
115                                 return false;
116                 }
117         }
118
119         return true;
120 }
121 EXPORT_SYMBOL(mdio45_links_ok);
122
123 /**
124  * mdio45_nway_restart - restart auto-negotiation for this interface
125  * @mdio: MDIO interface
126  *
127  * Returns 0 on success, negative on error.
128  */
129 int mdio45_nway_restart(const struct mdio_if_info *mdio)
130 {
131         if (!(mdio->mmds & MDIO_DEVS_AN))
132                 return -EOPNOTSUPP;
133
134         mdio_set_flag(mdio, mdio->prtad, MDIO_MMD_AN, MDIO_CTRL1,
135                       MDIO_AN_CTRL1_RESTART, true);
136         return 0;
137 }
138 EXPORT_SYMBOL(mdio45_nway_restart);
139
140 static u32 mdio45_get_an(const struct mdio_if_info *mdio, u16 addr)
141 {
142         u32 result = 0;
143         int reg;
144
145         reg = mdio->mdio_read(mdio->dev, mdio->prtad, MDIO_MMD_AN, addr);
146         if (reg & ADVERTISE_10HALF)
147                 result |= ADVERTISED_10baseT_Half;
148         if (reg & ADVERTISE_10FULL)
149                 result |= ADVERTISED_10baseT_Full;
150         if (reg & ADVERTISE_100HALF)
151                 result |= ADVERTISED_100baseT_Half;
152         if (reg & ADVERTISE_100FULL)
153                 result |= ADVERTISED_100baseT_Full;
154         return result;
155 }
156
157 /**
158  * mdio45_ethtool_gset_npage - get settings for ETHTOOL_GSET
159  * @mdio: MDIO interface
160  * @ecmd: Ethtool request structure
161  * @npage_adv: Modes currently advertised on next pages
162  * @npage_lpa: Modes advertised by link partner on next pages
163  *
164  * Since the CSRs for auto-negotiation using next pages are not fully
165  * standardised, this function does not attempt to decode them.  The
166  * caller must pass them in.
167  */
168 void mdio45_ethtool_gset_npage(const struct mdio_if_info *mdio,
169                                struct ethtool_cmd *ecmd,
170                                u32 npage_adv, u32 npage_lpa)
171 {
172         int reg;
173
174         ecmd->transceiver = XCVR_INTERNAL;
175         ecmd->phy_address = mdio->prtad;
176         ecmd->mdio_support =
177                 mdio->mode_support & (MDIO_SUPPORTS_C45 | MDIO_SUPPORTS_C22);
178
179         reg = mdio->mdio_read(mdio->dev, mdio->prtad, MDIO_MMD_PMAPMD,
180                               MDIO_CTRL2);
181         switch (reg & MDIO_PMA_CTRL2_TYPE) {
182         case MDIO_PMA_CTRL2_10GBT:
183         case MDIO_PMA_CTRL2_1000BT:
184         case MDIO_PMA_CTRL2_100BTX:
185         case MDIO_PMA_CTRL2_10BT:
186                 ecmd->port = PORT_TP;
187                 ecmd->supported = SUPPORTED_TP;
188                 reg = mdio->mdio_read(mdio->dev, mdio->prtad, MDIO_MMD_PMAPMD,
189                                       MDIO_SPEED);
190                 if (reg & MDIO_SPEED_10G)
191                         ecmd->supported |= SUPPORTED_10000baseT_Full;
192                 if (reg & MDIO_PMA_SPEED_1000)
193                         ecmd->supported |= (SUPPORTED_1000baseT_Full |
194                                             SUPPORTED_1000baseT_Half);
195                 if (reg & MDIO_PMA_SPEED_100)
196                         ecmd->supported |= (SUPPORTED_100baseT_Full |
197                                             SUPPORTED_100baseT_Half);
198                 if (reg & MDIO_PMA_SPEED_10)
199                         ecmd->supported |= (SUPPORTED_10baseT_Full |
200                                             SUPPORTED_10baseT_Half);
201                 ecmd->advertising = ADVERTISED_TP;
202                 break;
203
204         case MDIO_PMA_CTRL2_10GBCX4:
205         case MDIO_PMA_CTRL2_10GBKX4:
206         case MDIO_PMA_CTRL2_10GBKR:
207         case MDIO_PMA_CTRL2_1000BKX:
208                 ecmd->port = PORT_OTHER;
209                 ecmd->supported = 0;
210                 ecmd->advertising = 0;
211                 break;
212
213         /* All the other defined modes are flavours of optical */
214         default:
215                 ecmd->port = PORT_FIBRE;
216                 ecmd->supported = SUPPORTED_FIBRE;
217                 ecmd->advertising = ADVERTISED_FIBRE;
218                 break;
219         }
220
221         if (mdio->mmds & MDIO_DEVS_AN) {
222                 ecmd->supported |= SUPPORTED_Autoneg;
223                 reg = mdio->mdio_read(mdio->dev, mdio->prtad, MDIO_MMD_AN,
224                                       MDIO_CTRL1);
225                 if (reg & MDIO_AN_CTRL1_ENABLE) {
226                         ecmd->autoneg = AUTONEG_ENABLE;
227                         ecmd->advertising |=
228                                 ADVERTISED_Autoneg |
229                                 mdio45_get_an(mdio, MDIO_AN_ADVERTISE) |
230                                 npage_adv;
231                 } else {
232                         ecmd->autoneg = AUTONEG_DISABLE;
233                 }
234         } else {
235                 ecmd->autoneg = AUTONEG_DISABLE;
236         }
237
238         if (ecmd->autoneg) {
239                 u32 modes = 0;
240                 int an_stat = mdio->mdio_read(mdio->dev, mdio->prtad,
241                                               MDIO_MMD_AN, MDIO_STAT1);
242
243                 /* If AN is complete and successful, report best common
244                  * mode, otherwise report best advertised mode. */
245                 if (an_stat & MDIO_AN_STAT1_COMPLETE) {
246                         ecmd->lp_advertising =
247                                 mdio45_get_an(mdio, MDIO_AN_LPA) | npage_lpa;
248                         if (an_stat & MDIO_AN_STAT1_LPABLE)
249                                 ecmd->lp_advertising |= ADVERTISED_Autoneg;
250                         modes = ecmd->advertising & ecmd->lp_advertising;
251                 }
252                 if ((modes & ~ADVERTISED_Autoneg) == 0)
253                         modes = ecmd->advertising;
254
255                 if (modes & ADVERTISED_10000baseT_Full) {
256                         ecmd->speed = SPEED_10000;
257                         ecmd->duplex = DUPLEX_FULL;
258                 } else if (modes & (ADVERTISED_1000baseT_Full |
259                                     ADVERTISED_1000baseT_Half)) {
260                         ecmd->speed = SPEED_1000;
261                         ecmd->duplex = !!(modes & ADVERTISED_1000baseT_Full);
262                 } else if (modes & (ADVERTISED_100baseT_Full |
263                                     ADVERTISED_100baseT_Half)) {
264                         ecmd->speed = SPEED_100;
265                         ecmd->duplex = !!(modes & ADVERTISED_100baseT_Full);
266                 } else {
267                         ecmd->speed = SPEED_10;
268                         ecmd->duplex = !!(modes & ADVERTISED_10baseT_Full);
269                 }
270         } else {
271                 /* Report forced settings */
272                 reg = mdio->mdio_read(mdio->dev, mdio->prtad, MDIO_MMD_PMAPMD,
273                                       MDIO_CTRL1);
274                 ecmd->speed = (((reg & MDIO_PMA_CTRL1_SPEED1000) ? 100 : 1) *
275                                ((reg & MDIO_PMA_CTRL1_SPEED100) ? 100 : 10));
276                 ecmd->duplex = (reg & MDIO_CTRL1_FULLDPLX ||
277                                 ecmd->speed == SPEED_10000);
278         }
279 }
280 EXPORT_SYMBOL(mdio45_ethtool_gset_npage);
281
282 /**
283  * mdio45_ethtool_spauseparam_an - set auto-negotiated pause parameters
284  * @mdio: MDIO interface
285  * @ecmd: Ethtool request structure
286  *
287  * This function assumes that the PHY has an auto-negotiation MMD.  It
288  * will enable and disable advertising of flow control as appropriate.
289  */
290 void mdio45_ethtool_spauseparam_an(const struct mdio_if_info *mdio,
291                                    const struct ethtool_pauseparam *ecmd)
292 {
293         int adv, old_adv;
294
295         WARN_ON(!(mdio->mmds & MDIO_DEVS_AN));
296
297         old_adv = mdio->mdio_read(mdio->dev, mdio->prtad, MDIO_MMD_AN,
298                                   MDIO_AN_ADVERTISE);
299         adv = old_adv & ~(ADVERTISE_PAUSE_CAP | ADVERTISE_PAUSE_ASYM);
300         if (ecmd->autoneg)
301                 adv |= mii_advertise_flowctrl(
302                         (ecmd->rx_pause ? FLOW_CTRL_RX : 0) |
303                         (ecmd->tx_pause ? FLOW_CTRL_TX : 0));
304         if (adv != old_adv) {
305                 mdio->mdio_write(mdio->dev, mdio->prtad, MDIO_MMD_AN,
306                                  MDIO_AN_ADVERTISE, adv);
307                 mdio45_nway_restart(mdio);
308         }
309 }
310 EXPORT_SYMBOL(mdio45_ethtool_spauseparam_an);
311
312 /**
313  * mdio_mii_ioctl - MII ioctl interface for MDIO (clause 22 or 45) PHYs
314  * @mdio: MDIO interface
315  * @mii_data: MII ioctl data structure
316  * @cmd: MII ioctl command
317  *
318  * Returns 0 on success, negative on error.
319  */
320 int mdio_mii_ioctl(const struct mdio_if_info *mdio,
321                    struct mii_ioctl_data *mii_data, int cmd)
322 {
323         int prtad, devad;
324         u16 addr = mii_data->reg_num;
325
326         /* Validate/convert cmd to one of SIOC{G,S}MIIREG */
327         switch (cmd) {
328         case SIOCGMIIPHY:
329                 if (mdio->prtad == MDIO_PRTAD_NONE)
330                         return -EOPNOTSUPP;
331                 mii_data->phy_id = mdio->prtad;
332                 cmd = SIOCGMIIREG;
333                 break;
334         case SIOCGMIIREG:
335                 break;
336         case SIOCSMIIREG:
337                 if (!capable(CAP_NET_ADMIN))
338                         return -EPERM;
339                 break;
340         default:
341                 return -EOPNOTSUPP;
342         }
343
344         /* Validate/convert phy_id */
345         if ((mdio->mode_support & MDIO_SUPPORTS_C45) &&
346             mdio_phy_id_is_c45(mii_data->phy_id)) {
347                 prtad = mdio_phy_id_prtad(mii_data->phy_id);
348                 devad = mdio_phy_id_devad(mii_data->phy_id);
349         } else if ((mdio->mode_support & MDIO_SUPPORTS_C22) &&
350                    mii_data->phy_id < 0x20) {
351                 prtad = mii_data->phy_id;
352                 devad = MDIO_DEVAD_NONE;
353                 addr &= 0x1f;
354         } else if ((mdio->mode_support & MDIO_EMULATE_C22) &&
355                    mdio->prtad != MDIO_PRTAD_NONE &&
356                    mii_data->phy_id == mdio->prtad) {
357                 /* Remap commonly-used MII registers. */
358                 prtad = mdio->prtad;
359                 switch (addr) {
360                 case MII_BMCR:
361                 case MII_BMSR:
362                 case MII_PHYSID1:
363                 case MII_PHYSID2:
364                         devad = __ffs(mdio->mmds);
365                         break;
366                 case MII_ADVERTISE:
367                 case MII_LPA:
368                         if (!(mdio->mmds & MDIO_DEVS_AN))
369                                 return -EINVAL;
370                         devad = MDIO_MMD_AN;
371                         if (addr == MII_ADVERTISE)
372                                 addr = MDIO_AN_ADVERTISE;
373                         else
374                                 addr = MDIO_AN_LPA;
375                         break;
376                 default:
377                         return -EINVAL;
378                 }
379         } else {
380                 return -EINVAL;
381         }
382
383         if (cmd == SIOCGMIIREG) {
384                 int rc = mdio->mdio_read(mdio->dev, prtad, devad, addr);
385                 if (rc < 0)
386                         return rc;
387                 mii_data->val_out = rc;
388                 return 0;
389         } else {
390                 return mdio->mdio_write(mdio->dev, prtad, devad, addr,
391                                         mii_data->val_in);
392         }
393 }
394 EXPORT_SYMBOL(mdio_mii_ioctl);