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