xref: /freebsd/sys/dev/mii/rdcphy.c (revision 2f02600abfddfc4e9f20dd384a2e729b451e16bd)
1 /*-
2  * Copyright (c) 2010, Pyun YongHyeon <yongari@FreeBSD.org>
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice unmodified, this list of conditions, and the following
10  *    disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25  * SUCH DAMAGE.
26  */
27 
28 #include <sys/cdefs.h>
29 __FBSDID("$FreeBSD$");
30 
31 /*
32  * Driver for the RDC Semiconductor R6040 10/100 PHY.
33  */
34 
35 #include <sys/param.h>
36 #include <sys/systm.h>
37 #include <sys/kernel.h>
38 #include <sys/module.h>
39 #include <sys/socket.h>
40 #include <sys/bus.h>
41 
42 #include <net/if.h>
43 #include <net/if_media.h>
44 
45 #include <dev/mii/mii.h>
46 #include <dev/mii/miivar.h>
47 #include "miidevs.h"
48 
49 #include <dev/mii/rdcphyreg.h>
50 
51 #include "miibus_if.h"
52 
53 static device_probe_t	rdcphy_probe;
54 static device_attach_t	rdcphy_attach;
55 
56 struct rdcphy_softc {
57 	struct mii_softc mii_sc;
58 	int mii_link_tick;
59 #define	RDCPHY_MANNEG_TICK	3
60 };
61 
62 static device_method_t rdcphy_methods[] = {
63 	/* device interface */
64 	DEVMETHOD(device_probe,		rdcphy_probe),
65 	DEVMETHOD(device_attach,	rdcphy_attach),
66 	DEVMETHOD(device_detach,	mii_phy_detach),
67 	DEVMETHOD(device_shutdown,	bus_generic_shutdown),
68 	DEVMETHOD_END
69 };
70 
71 static devclass_t rdcphy_devclass;
72 
73 static driver_t rdcphy_driver = {
74 	"rdcphy",
75 	rdcphy_methods,
76 	sizeof(struct rdcphy_softc)
77 };
78 
79 DRIVER_MODULE(rdcphy, miibus, rdcphy_driver, rdcphy_devclass, 0, 0);
80 
81 static int	rdcphy_service(struct mii_softc *, struct mii_data *, int);
82 static void	rdcphy_status(struct mii_softc *);
83 
84 static const struct mii_phydesc rdcphys[] = {
85 	MII_PHY_DESC(RDC, R6040),
86 	MII_PHY_END
87 };
88 
89 static const struct mii_phy_funcs rdcphy_funcs = {
90 	rdcphy_service,
91 	rdcphy_status,
92 	mii_phy_reset
93 };
94 
95 static int
96 rdcphy_probe(device_t dev)
97 {
98 
99 	return (mii_phy_dev_probe(dev, rdcphys, BUS_PROBE_DEFAULT));
100 }
101 
102 static int
103 rdcphy_attach(device_t dev)
104 {
105 
106 	mii_phy_dev_attach(dev, MIIF_NOMANPAUSE, &rdcphy_funcs, 1);
107 	return (0);
108 }
109 
110 static int
111 rdcphy_service(struct mii_softc *sc, struct mii_data *mii, int cmd)
112 {
113 	struct rdcphy_softc *rsc;
114 	struct ifmedia_entry *ife;
115 
116 	rsc = (struct rdcphy_softc *)sc;
117 	ife = mii->mii_media.ifm_cur;
118 
119 	switch (cmd) {
120 	case MII_POLLSTAT:
121 		break;
122 
123 	case MII_MEDIACHG:
124 		mii_phy_setmedia(sc);
125 		switch (IFM_SUBTYPE(ife->ifm_media)) {
126 		case IFM_100_TX:
127 		case IFM_10_T:
128 			/*
129 			 * Report fake lost link event to parent
130 			 * driver.  This will stop MAC of parent
131 			 * driver and make it possible to reconfigure
132 			 * MAC after completion of link establishment.
133 			 * Note, the parent MAC seems to require
134 			 * restarting MAC when underlying any PHY
135 			 * configuration was changed even if the
136 			 * resolved speed/duplex was not changed at
137 			 * all.
138 			 */
139 			mii->mii_media_status = 0;
140 			mii->mii_media_active = IFM_ETHER | IFM_NONE;
141 			rsc->mii_link_tick = RDCPHY_MANNEG_TICK;
142 			/* Immediately report link down. */
143 			mii_phy_update(sc, MII_MEDIACHG);
144 			return (0);
145 		default:
146 			break;
147 		}
148 		break;
149 
150 	case MII_TICK:
151 		if (mii_phy_tick(sc) == EJUSTRETURN)
152 			return (0);
153 		if (IFM_SUBTYPE(ife->ifm_media) != IFM_AUTO) {
154 			/*
155 			 * It seems the PHY hardware does not correctly
156 			 * report link status changes when manual link
157 			 * configuration is in progress.  It is also
158 			 * possible for the PHY to complete establishing
159 			 * a link within one second such that mii(4)
160 			 * did not notice the link change.  To workaround
161 			 * the issue, emulate lost link event and wait
162 			 * for 3 seconds when manual link configuration
163 			 * is in progress.  3 seconds would be long
164 			 * enough to absorb transient link flips.
165 			 */
166 			if (rsc->mii_link_tick > 0) {
167 				rsc->mii_link_tick--;
168 				return (0);
169 			}
170 		}
171 		break;
172 	}
173 
174 	/* Update the media status. */
175 	PHY_STATUS(sc);
176 
177 	/* Callback if something changed. */
178 	mii_phy_update(sc, cmd);
179 	return (0);
180 }
181 
182 static void
183 rdcphy_status(struct mii_softc *sc)
184 {
185 	struct mii_data *mii;
186 	struct ifmedia_entry *ife;
187 	int bmsr, bmcr, physts;
188 
189 	mii = sc->mii_pdata;
190 	ife = mii->mii_media.ifm_cur;
191 
192 	mii->mii_media_status = IFM_AVALID;
193 	mii->mii_media_active = IFM_ETHER;
194 
195 	bmsr = PHY_READ(sc, MII_BMSR) | PHY_READ(sc, MII_BMSR);
196 	physts = PHY_READ(sc, MII_RDCPHY_STATUS);
197 
198 	if ((physts & STATUS_LINK_UP) != 0)
199 		mii->mii_media_status |= IFM_ACTIVE;
200 
201 	bmcr = PHY_READ(sc, MII_BMCR);
202 	if ((bmcr & BMCR_ISO) != 0) {
203 		mii->mii_media_active |= IFM_NONE;
204 		mii->mii_media_status = 0;
205 		return;
206 	}
207 
208 	if ((bmcr & BMCR_LOOP) != 0)
209 		mii->mii_media_active |= IFM_LOOP;
210 
211 	if ((bmcr & BMCR_AUTOEN) != 0) {
212 		if ((bmsr & BMSR_ACOMP) == 0) {
213 			/* Erg, still trying, I guess... */
214 			mii->mii_media_active |= IFM_NONE;
215 			return;
216 		}
217 	}
218 
219 	switch (physts & STATUS_SPEED_MASK) {
220 	case STATUS_SPEED_100:
221 		mii->mii_media_active |= IFM_100_TX;
222 		break;
223 	case STATUS_SPEED_10:
224 		mii->mii_media_active |= IFM_10_T;
225 		break;
226 	default:
227 		mii->mii_media_active |= IFM_NONE;
228 		return;
229 	}
230 	if ((physts & STATUS_FULL_DUPLEX) != 0)
231 		mii->mii_media_active |= IFM_FDX | mii_phy_flowstatus(sc);
232 	else
233 		mii->mii_media_active |= IFM_HDX;
234 }
235